Pythonのダブルクォーテーション3つで囲まれたコメントについて現役エンジニアが解説【初心者向け】

初心者向けにPythonのダブルクォーテーション3つで囲まれたコメントについて現役エンジニアが解説しています。コメントはプログラムの処理がスキップ(無視)される個所になります。メモやデバッグに使いますが、複数行のコメントにはダブルクォーテーションを3つ書きます。

TechAcademyマガジンはオンラインのプログラミングスクールTechAcademy [テックアカデミー]が運営する教育×テクノロジーのWebメディアです。初心者でもすぐ勉強できる記事が2,000以上あります。

Pythonのダブルクォーテーション3つで囲まれたコメントについて、TechAcademyのメンター(現役エンジニア)が実際のコードを使用して、初心者向けに解説します。

Pythonについてそもそもよく分からないという方は、Pythonとは何なのか解説した記事を読むとさらに理解が深まります。

 

なお本記事は、TechAcademyのオンラインブートキャンプ、Python講座の内容をもとに紹介しています。

 

田島悠介

今回は、Pythonに関する内容だね!

大石ゆかり

どういう内容でしょうか?

田島悠介

Pythonのダブルクォーテーション3つで囲まれたコメントについて詳しく説明していくね!

大石ゆかり

お願いします!

Pythonだけに限りませんが、プログラミングにおいてコメントは重要な役割を果たします。

他人や自分のためのメモとして使うのはもちろんのこと、コメントアウトしてデバッグする際にも役立ちます。また、フォルダのdeleteなどの一度行うと取り返しがつかないようなコードをコメントアウトし、deleteされるフォルダを確認してからコメントを外すといった使い方もあります。

ただ、多くの記事や参考書ではコメントについてあまり詳しく書かれていないのが現状です。そこでこの記事では、Pythonにおけるコメントについての仕方について徹底的に解説します。

ダブルクォーテーション3つで囲まれたコメントについて

普通のコメントを#で行うのは多くの方がご存知かと思いますので、複数業のコメントのやり方から解説していきます。複数行のコメントを書こうと思った際に以下のように書くのは面倒ですよね。

#コメント1行目
#コメント2行目
#コメント3行目

そのため、複数行コメントは以下のようにダブルクォーテーションで囲んであげるのが普通です。

"""
コメント1行目
コメント2行目
コメント3行目
"""

こうすることで、例え膨大な行のコメントを書かなければならなくなったとしても、瞬時にコメントを作成できます。また、複数行コメントはダブルクォーテーションでなくシングルクォーテーションを用いて以下のように書くこともできます。

'''
コメント1行目
コメント2行目
コメント3行目
'''

 

シングルクォートとダブルクォートの違い

ではシングルクォートとダブルクォートのどちらを使えばいいのでしょうか?結論から言うと、どちらでも大丈夫です。完全に好みの問題です。

ただし、以下のようにコメント文自体にクォーテーションを使いたいときには、以下のようにシングルクォートとダブルクォートを分けた方が見やすいでしょう。

'''
一番上を"header"という。
真ん中を"body"という。
一番下を"footer"という。
'''

 

[PR] Pythonで挫折しない学習方法を動画で公開中

その他のコメントの書き方との比較

その他のコメントの書き方として、関数アノテーションというものがあります。

これはPython3系から追加された機能です。このようにして関数に関する説明をする方法もあります。アノテーションの箇所には変数のデータ型を書くことが多いです。ただし、初心者の方は知らなくても大丈夫かと

def function_2st(s: "sのアノテーション", t: "tのアノテーション") -> '戻り値のアノテーション':
return 2 * s * t

 

まとめ

この記事ではPythonのコメントの書き方について徹底的に解説しました。これで今後コメントについて悩むことはなくなるでしょう。

監修してくれたメンター

柴山真沙希(しばやままさき)

大手IT企業などでエンジニアとして2年ほど勤務した後、個人事業主としてプログラミングスクール「エンペサール」を経営。子供から大人まで幅広い層を対象にプログラミングを教えている。

得意言語はPython, HTML, CSSで、機械学習やデータ分析、スクレイピングなどが得意。サッカー観戦や読書が趣味である。

 

大石ゆかり

内容分かりやすくて良かったです!

田島悠介

ゆかりちゃんも分からないことがあったら質問してね!

大石ゆかり

分かりました。ありがとうございます!

 

TechAcademyでは、初心者でも最短4週間で、Pythonを使った人工知能(AI)や機械学習の基礎を習得できる、オンラインブートキャンプを開催しています。

また、現役エンジニアから学べる無料体験も実施しているので、ぜひ参加してみてください。