Pythonでコメントする方法

2021年7月に更新

はじめに

コードを書く際の重要なスキルは、コメントを使用する能力です。コメントは、コンパイラーとインタープリターが、開発者がコードの機能に関するメモを残すために使用することを無視する行です。さらに、コードの一部を無効にするためにも使用できます。

このガイドでは、Pythonでコメントを効果的に使用する方法を説明します。

前提条件

動作するPythonプログラミング環境
Pythonファイルを作成および編集する機能

Pythonコメント構文

コメントとして行を追加またはマークするには、ハッシュ記号から始めます。（＃）とスペース ：

# This is a sample comment.

ハッシュ記号を使用して行を開始すると、その行のすべてを無視するようにシステムに指示されます。アプリケーションが実行されると、プログラムはそれらの行が存在しないように見せかけます。ただし、ファイルを編集すると、引き続き表示されます。

たとえば、 Hello World 以下のプログラム：

# Display the text "Hello, World!" on the screen.
print("Hello, World!")

システムはコードprint("Hello, World")を実行します 4行目ですが、上の行はコードの機能を説明しています。

コメントとして任意の行を設定し、好きなだけ使用することができます。コードに異なるブロックがある場合は、コメントを使用してそれぞれを説明できます。例：

# Define a variable flowers as a list of strings.
flowers = [‘rose’, ‘carnation’, ‘daisy’, ‘marigold’, ‘tulip’, ‘sunflower’]

# Create a for loop to iterate through flowers list, and displays each string item.
for flower in flowers:
            print(flower)

Pythonコメントブロック

コメントをブロックする 行の複数の行で構成される長い形式のコメントです。開発者は、特にチームで作業する場合に、それらを使用してより複雑なコードを説明します。

一連の行をコメントとしてマークするには、ハッシュ記号を追加します +スペース 各行の先頭：

# This is a comment
# that runs on to
# multiple lines.

プログラミング用の一部のテキストまたはコードエディタ（Notepad ++やAtomなど）では、テキストを強調表示してから、マウスをクリックしてブロックをコメントとしてマークできます。これらのツールを使用すると、各行をコメントアウトする時間を節約できます。

Pythonマルチラインコメント

通常、 #を使用することをお勧めします 各行の先頭にコメントとしてマークを付けます。ただし、大きなセクションにコメントを付けるには時間がかかるため、セクション全体をコメントアウトするための簡単な方法が必要になる場合があります。このような場合、複数行のコメントを使用できます。。

複数行の文字列は、公式の複数行の機能がないため、従来のPythonコメントとしては機能しません。代わりに、三重引用符で囲まれた複数行の文字列を使用してください（ """ ）同様の機能を実現します。

例：

def addition_test(a, b):
    result = a + b
    """
    This is a block
    of commented lines.
    They aren’t parsed and interpreted by the compiler.
    """
return result

このメソッドは、真のコメントではなく、関数のないテキスト定数を作成します。そのテキスト文字列にアクセスするものを追加しない限り、通常のコメントと同じように機能します。

三重引用符は、状況によっては docstring を作成するため、注意が必要な場合があります。トリプルクォートの場合：

関数のシグネチャに従います
クラス定義に従います
モジュールの開始時です。

"""を配置した場合 上記の場所の1つで、Pythonはそれをドスティングとして読み取ります。 Docstringを使用すると、人間が読めるテキストをプロジェクトに入れることができます。これは通常、アプリケーションの一部であり、実行時にアクセスできるドキュメントを作成するために使用されます。

Pythonインラインコメント

インラインコメントを使用して、コードと同じ行にコメントを付けることができます。このオプションを使用するのに最適なのは、複雑な操作を説明するときです。

インラインコメントを使用して、明確にしたい正確な場所を指摘します。標準のハッシュ記号を追加します +スペース インラインコメントを示すには：

function
    set variable
    run command
    run additional command        # Tricky part:  The program breaks if this line is removed.

インラインコメントは、コードを読む人々のコンテキストを追加するために使用されます。たとえば、変数の目的を説明したり、作成された変数のタイプについてメモを残したりできます。上記の例のように、特定のコマンドが使用される理由を説明することも役立ちます。

Pythonコメントアウト

コメントはテキストをパーサーから見えなくするため、コメントを使用してコマンドを無効にすることができます。そうすることで、新しい追加がある場合とない場合のコードのセグメントをテストできます。

たとえば、この単純なサイコロを振るプログラムには、コメントアウトされたセクションがあります。ハッシュ記号を削除すると、コードでテストできるようになります。

import random
min = 1
max = 6

roll_again = "yes"

while roll_again == "yes" or roll_again == "y":
     print "Rolling the dice..."
     print "The values are...."
     print random.randint(min, max)
     print random.randint(min, max)

# Add two random numbers together for a sum
# while roll_again == “yes” or roll_again == “y”:
    # print ”Rolling the dice…”
    # print “You rolled a “
    # print random.randint(min,max) + random.randint(min, max)

    roll_again = raw_input("Roll the dice again?")

Pythonでコメントが重要な理由

コメントはあなたを助けることができます：

長期間経過してコードに戻ったときに、自分のコードを理解してください。
より速くスピードを取り戻すことができます。
デバッグの問題。
チーム内で作業するときの特定のコードの選択を理解します。
特定のコード部分が重要である理由を強調することにより、潜在的な問題を防ぎます。

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

参照しているコードと同じインデントにコメントします。これにより、参照している内容を簡単に確認できます。
コードを更新するときにコメントを更新します。間違ったコメントはコメントがないよりも悪いです。
完全な文を使用します。識別子（変数など）を参照している場合を除き、適切な単語を大文字にします。識別子の大文字と小文字を変更しないでください。
ブロックコメントは、ピリオドを付けた完全な文で書き出す必要があります。 1行あたり80語以下を目指します。
コメントに複数の文がある場合は、文の間にダブルスペースを使用してください。
英語でコメントを書いてください。
複数の段落を含むブロックコメントの場合、段落の間に空白行を追加し、空白行の前に1つのコメントタグを付けます。
インラインコメントの場合、コードとコメントの間に少なくとも2つのスペースを残します。インラインコメントは控えめに使用し、明白なことを述べるために使用することは避けてください。

回避：

自明のコードにはコメントしないでください。 DRYを書くという原則に固執する（ D Rではありません epeat Y 私たち自身）そしてウェットを避けてください（ W 儀式E 非常にT wice）コードとコメント。
厄介なコードを説明するためにコメントを使用することは避けてください。コメントは、それを正当化するのではなく、コードをサポートする必要があります。