PythonのコメントとGoogleスタイルのDocstring

Pythonでは、コードの理解を助けるためにコメントを書くことが一般的です。特に、関数やクラスの説明を記述するための「Docstring」は重要な要素です。

Pythonのコメント

Pythonのコメントは、コードの動作には影響を与えません。コメントは主にプログラムの説明や備忘録を書くために使用されます。Pythonでは、単一行コメントと複数行コメントの2つの形式があります。

単一行コメント

単一行コメントは、ハッシュ記号「#」から行末までをコメントとします。以下に例を示します。

# これは単一行コメントです
print("Hello, World!")  # この部分もコメントです

複数行コメント

複数行コメントは、3つのダブルクォートで囲むことで作成します。以下に例を示します。

"""
これは
複数行
コメントです
"""
print("Hello, World!")

GoogleスタイルのDocstring

GoogleスタイルのDocstringは、Pythonの公式ドキュメンテーションでも推奨されている形式の一つです。この形式では、関数やクラスの説明を詳細に記述することができます。

以下に、GoogleスタイルのDocstringの基本的な書き方を示します。

def example_function(param1, param2):
    """
    関数の説明タイトル

    関数についての詳細な説明文

    Args:
        param1 (type): param1の説明
        param2 (type): param2の説明

    Returns:
        type: 戻り値の説明
    """
    return param1 + param2

この形式を使用すると、関数やクラスの目的、引数、戻り値などを明確に記述することができます。これにより、他の開発者がコードを理解しやすくなります。

以上がPythonのコメントとGoogleスタイルのDocstringについての基本的な説明です。これらの知識を活用して、より理解しやすいコードを書くことができます。