Pythonでのコメントの書き方

Pythonでのコメントの書き方について解説します。コメントはコードの理解を助け、他の開発者とのコミュニケーションを円滑にするために重要な要素です。

一行コメント

Pythonでは、#（シャープ）を使って一行コメントを書くことができます。#以降に書く文章は、その行の終わりまで無視されます。

print("Hello world!") # これは一行コメントです

上記のコードでは、print("Hello world!")の後に#があり、それ以降のテキストはコメントとして扱われます。このコメントはコードの実行時に無視されます。

複数行にわたるコメントを書く場合、'''（シングルクォーテーション3つ）または"""（ダブルクォーテーション3つ）を使用します。

'''
これは
複数行の
コメントです
'''
print("Hello world!")

上記のコードでは、print("Hello world!")の前に複数行のコメントがあります。このコメントもまた、コードの実行時に無視されます。

Docstringは、関数やクラスなどの説明を書くための特殊なコメントです。Docstringは'''（シングルクォーテーション3つ）または"""（ダブルクォーテーション3つ）を使用して書きます。

def hello_world():
    """
    これはdocstringです。
    この関数は"Hello, World!"を出力します。
    """
    print("Hello, World!")

上記のコードでは、hello_world関数の直下にdocstringがあります。このdocstringは、関数の説明として使用されます。

以上がPythonでのコメントの基本的な書き方です。適切なコメントはコードの可読性を高め、バグの発見や修正を容易にします。ぜひ活用してください。