Pythonにおける複数行コメントの記述方法を現役エンジニアが解説【初心者向け】

Pythonにおける複数行コメントの記述方法について、テックアカデミーのメンター（現役エンジニア）が実際のコードを使用して初心者向けに解説します。

目次

• コメント機能とは？
• コメント機能の使い方
• コメント機能を使って複数行のコメントをしてみよう
• まとめ
• Pythonを学習中の方へ

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

 

 

コメント機能とは？

プログラムを書く際、どの言語においても処理内容や関数の説明を載せるときにソースコードにメモ（コメント）を残します。

この機能をコメント機能またはコメントアウトといいます。

コメント機能を使うことでプログラムに影響することなくソースコード内にメモを残せます。

また、コメントアウトによってソースコードの一部を実行されないようにできます。

 

コメント機能は次のような目的で使われます。

• 自身でソースコードを見直す時に備えて、何を考えてそのコードを書いたのか記しておくため。
• 自分の意図を伝えることで、ソースコードを他の人にも理解しやすくするため。
• エラーの原因を探す際や、コードの書き方を試行錯誤する際に、特定の行を実行しないようにするため。

 

コメント機能の使い方

1行のコメント

1行でコメントアウトを行う際には#使って記述します。

例

# ここはコメント
# print("ここもコメント、実行しない")
print("ここは実行する")

 

複数行のコメント

今回の本題の複数行でのコメントです。

複数行でコメントを残すときには、シングルクォーテーションまたはダブルクォーテーションを3つつなげたもので両端を囲んでコメントアウトします。

この手法はGitHubで公開しているコードやドキュメント作成を行う際にはよく使用されます。

例

"""
ここはコメントです。
実行はされません。
"""
print("Hello World")

 

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

コメント機能を使って複数行のコメントをしてみよう

それでは、複数行のコメントをしてみましょう。

まずは以下のソースコードをコピーして任意の場所に保存しましょう。

def test(a):
    """引数
    a:数字（int）
    """
    return a + 1
print(test(2))

上記コードを実行すると、test関数に2を引数として渡した結果が返ってくると思います。

関数内のコメントで引数の説明を入れているのが分かります。

このようにして、関数の説明を行い引数を説明することで、引き継ぎで誰かにコードを渡す際に関数内の処理を知れてチーム開発の効率があがります。

複数行のコメントを行う際は、インデントに注意する必要があります。

関数の定義, if文などインデントを行うブロック内で複数行のコメントを行う場合は、上記コードのようにコメント部分もインデントを揃える必要があります。

 

まとめ

今回はPythonにおいてのコメント機能を紹介しました。

他人に自分のソースコードを読んでもらうためにコメントはとても大切です。

ただし、あまり使いすぎるとかえって読みづらくなるので、適度に使うようにしましょう。

 

 

Pythonを学習中の方へ

これで解説は終了です、お疲れさまでした。

• つまずかず「効率的に」学びたい
• 副業や転職後の「現場で使える」知識やスキルを身につけたい

プログラミングを学習していて、このように思ったことはありませんか？

テックアカデミーのPythonコースでは、第一線で活躍する「プロのエンジニア」が教えているので、効率的に実践的なスキルを完全オンラインでしっかり習得できます。

合格率10%の選考を通過した、選ばれたエンジニアの手厚いサポートを受けながら、人工知能（AI）や機械学習の基礎を学べます。

まずは一度、無料体験で学習の悩みや今後のキャリアについて話してみて、「現役エンジニアから教わること」を実感してみてください。

時間がない方、深く知ってから体験してみたい方は、今スグ見られる説明動画から先に視聴することをおすすめします！