コメントの使い方

コードの中にコメントを入れることで、後から見たときにそのコードが何をしているのかを理解しやすくなります。コメントはプログラムの実行には影響しませんが、コードの可読性を向上させるために非常に重要です。特に複雑な処理を行う部分や他の人と共同作業をする場合には、コメントが役立ちます。

シングルラインコメント

Pythonでは、シングルラインコメントを記述するために # 記号を使用します。 # の右側に書かれたすべてのテキストはコメントと見なされ、Pythonインタプリタはそれを無視します。

例：

# これはシングルラインコメントです
print("Hello, World!")  # ここにもコメントを追加できます

複数行コメント

Pythonには公式な複数行コメントの構文はありませんが、複数行にわたるコメントを記述するための方法はいくつかあります。一つの方法は、各行の先頭に # を付けることです。

例：

# これは複数行にわたる
# コメントの例です。
# 各行の先頭に '#' を付けています。
print("Hello, World!")

ドキュメンテーション文字列（docstring）

Pythonでは、関数やクラス、モジュールの先頭にドキュメンテーション文字列（docstring）を使ってコメントを記述することができます。ドキュメンテーション文字列はトリプルクォート（""" または '''）で囲まれた文字列です。これは主に、関数やクラスの説明を提供するために使用されます。

例：

def greet(name):
    """
    この関数は与えられた名前を持つ人に挨拶します。

    引数:
    name -- 挨拶する相手の名前
    """
    print(f"Hello, {name}!")

# 関数の呼び出し
greet("Alice")

ドキュメンテーション文字列は、関数の__doc__属性としてアクセス可能です。

print(greet.__doc__)

コメントのベストプラクティス

コメントを書く際には、いくつかのベストプラクティスを心がけるとよいでしょう。

明確で簡潔に：コメントは明確で簡潔に書きましょう。過度に冗長なコメントは避け、要点を簡潔に伝えます。
最新の状態に保つ：コードを変更したら、コメントも忘れずに更新しましょう。古いコメントは混乱を招くことがあります。
説明的に：コメントはコードの目的や理由を説明するために使用しましょう。コードそのものが何をしているかを説明するだけでなく、なぜそのような方法を選んだのかを記述すると良いです。
ドキュメンテーションコメント：関数やクラスのドキュメンテーションコメントは、その機能や使用方法を他の開発者に伝えるために詳細に書きます。

例：

def calculate_area(radius):
    """
    この関数は円の面積を計算します。

    引数:
    radius -- 円の半径

    戻り値:
    円の面積
    """
    if radius < 0:
        raise ValueError("半径は正の値でなければなりません")
    area = 3.14159 * (radius ** 2)
    return area

# 関数の呼び出し
area = calculate_area(5)
print(f"円の面積は: {area}")

まとめ

この章では、Pythonのコメントの使い方について学びました。コメントは、コードの可読性を向上させ、他の人や未来の自分がコードを理解するのに役立ちます。次に、Pythonの条件分岐について学びます。条件分岐を使うことで、プログラムに柔軟な動作を持たせることができます。