Pythonでコメントを追加する方法


  1. 単一行コメント: 単一行コメントは、行の先頭に「#」を追加することで作成できます。この方法は、その行の後ろにあるコードに関する簡単な説明やメモを追加するのに便利です。例えば:

    # この行は変数xを初期化します
    x = 10
  2. 複数行コメント: 複数行コメントは、複数行にわたるコメントを追加する際に使用します。Pythonでは、複数行コメントを直接サポートしていないため、複数行文字列を使用します。例えば:

    """
    この部分は
    複数行のコメントです。
    """

    または:

    '''
    この部分も
    複数行のコメントです。
    '''

    複数行文字列は、単なるコメントとして扱われ、実行時には無視されます。

  3. ドキュメンテーション文字列: ドキュメンテーション文字列は、関数やクラスなどの要素に関する説明やドキュメントを提供するために使用されます。関数やクラスの定義の直後に文字列を追加することで、ドキュメンテーション文字列を作成できます。例えば:

    def my_function():
       """
       この関数は、何らかの処理を行います。
       """
       # 処理のコード

    ドキュメンテーション文字列は、関数やクラスの属性としてアクセスすることもできます。

これらの方法を使用して、Pythonコードにコメントを追加することができます。コメントは、コードの読みやすさやメンテナンス性を向上させるために積極的に活用することをおすすめします。