Pythonでのコメントの書き方

Pythonでのコメントはコードに付加するメモで、コードの動作や設計を説明するのに役立ちます。この記事では、インラインコメントとブロックコメントの違いや、特殊なコメント、PEP 8スタイルガイドに基づくコメントの書き方などを紹介します。

コメントとは

コメントの書き方を解説する前に、コメントとは何かを解説します。プロジェクトでは自分が書いているコードの目的や説明を、第三者に正しく伝える必要があります。なぜなら他人のコードは説明無しで解読するのはとても難しいことだからです。

Pythonでコードにコメントを挿入する時は、 # （シャープ）を使います。 #以降に書く文章は、その行の終わりまで無視されることになります。

一行コメントは、 # の後にコメントを書きます。例えば、以下のようになります。

print("Hello world!") # display "Hello" with print function.

このコードでは、 print 関数を使用して指定した文字列を表示させています。 # 以降に書かれたコードと説明は出力されず、一行目の「Hello world!」のみが表示されます。

複数行コメントは、 ''' または """ を使用してコメントを書きます。例えば、以下のようになります。

print("Hello world!1")
'''
print("Hello world!2")
print("Hello world!3")
print("Hello world!4")
'''

このコードでは、2行目以降の3行を複数行に渡ってコメントアウトしています。実際、出力された文字列は一行目の「Hello world!1」のみです。

docstringを簡単に解説すると、自作の関数やクラスなどに付ける説明文のことです。docstringを使用する主なメリットとしては、モジュールやクラスや関数などの使い方などが記入された「説明書」のようなものを参照したい時に、docstringの内容が表示されることです。

"""
docstringの使い方を説明するためのモジュールです。
"""
def func():
    """
    この関数は文字列Hello worldをプリントします。
    """
    print("Hello world")

このコードでは、関数 func の説明として、 """ で囲まれた部分がdocstringとして扱われます。

以上がPythonでのコメントの基本的な書き方になります。これらを理解し、適切にコメントを書くことで、他の人があなたのコードを理解しやすくなります。.