Pythonコメント：ステップバイステップガイド

Pythonコメントは、インタプリタによって実行されないプログラム内のテキスト行です。コメントは、デバッグ中に問題を特定し、コードを説明するために使用されます。コメントはハッシュ文字（＃）で始まります。

Pythonでコメントする方法

コメントは、Pythonで実行したくないメモまたはコードを示します。たとえば、複雑な手順を数時間にわたって作成しているとします。追跡を失うことがないように、コードの各行が何をするかを追跡するために、いくつかのコメントを書くことをお勧めします。

コメントを書くことは多くの理由で役に立ちます。大きなPythonプログラムで作業している場合、コメントは何が起こっているかを追跡するのに役立ちます。コメントすることで、チームメンバーは、共同プロジェクトでのお互いの作業を全員が確実に理解できるようになります。

すべての開発者は、最終的に、コードを書くときにコメントを含める必要がある状況に遭遇します。

しかし、Pythonのコードについてどのようにコメントしますか？他のすべてのプログラミング言語と同様に、Pythonはコメントをサポートしています。このガイドでは、Pythonでコメントを書く方法について説明します。

Pythonコメントとは何ですか？

Pythonコメントは、プログラムに表示されるがプログラムによって実行されないテキスト行です。ハッシュタグ（＃）を使用してコメントを宣言できます。コメントは、新しい行または既存のコード行の最後に表示できます。

コメントは、コードがどのように機能するかを説明するため、およびテスト目的で使用されます。

Pythonでの1行コメントの例を次に示します。

参加者の81％は、ブートキャンプに参加した後、自分たちの技術的な仕事の見通しについてより自信を持っていると述べました。今日のブートキャンプにマッチしましょう。

平均的なブートキャンプの卒業生は、ブートキャンプの開始から最初の仕事を見つけるまで、キャリアの移行に6か月も費やしませんでした。

# This is a demo comment

＃ハッシュマークがコメントを示していることがわかります。コメントテキストと＃記号はスペースで区切ります。これは必須ではありませんが、各コメントが読みやすくなります。

この行は、コードを実行するときにコンパイラーによって無視されます。コメントは人間が読む必要があります。プログラムが実行するためのものではありません。

コメントは、コメントが参照しているコードと同じインデントレベルで追加する必要があります。たとえば、 if内のコード行について書いているとします。 声明。コードで行ったのと同じ方法でコメントをインデントします。

Pythonコメントの例

forループを作成していて、それがどのように機能するかを思い出したいとします。あなたはいくつかのコメントを書きたいかもしれません。後でコードを見に戻ったときに、メモを読むことができます。

Pythonのforループでは、次のようなコメントが表示される場合があります。

# Define students variable as an array of strings
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

# Loop through each item in the students array and print out each name
for s in students:
	print("Student Name: ", s)

コメントは、コードの目的を理解し、何が起こっているかを追跡するのに役立ちます。

例を使用して、Pythonでのコメントのインデント構造を説明しましょう。次の例では、プログラムが2つのPython配列をループし、各生徒にパスを与えます。 または失敗 彼らのテストのために。合格と不合格は、テストの生徒の数値スコアに基づいて決定されます。

# Define an array with student names
students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

# Define an array with student grades
numericalGrades = [55, 72, 64, 86, 86, 59]

# Loop through every student in "students" array
for s in range(0, len(students)):
	# Check if the student's numerical grade is equal to or above 60
if numericalGrades[s] >= 60:
	# Print a message saying the student has passed their test
print(students[s], "passed their test.")
else:
	# Print a message saying the student has failed their test
print(students[s], "failed their test.")

このプログラムは、学生とその成績のリストを取ります。次に、プログラムは学生のリストをループします。各生徒がテストに合格したか失敗したかを確認します。

上記の例では、参照している行と同じインデントレベルにコメントしていることがわかります。たとえば、Python ifステートメントについて説明しているときは、コードだけでなくコメントもインデントしています。

これらの1行のコメントを書くことにより、私たちのプログラムは、コードの作成者の両方にとってより読みやすくなります。私たちのプログラムは、私たちのプログラムを見る可能性のある他の人にとっても読みやすくなっています。

Pythonインラインコメント

Pythonインラインコメントは、コードが記述された後、ステートメントと同じ行に書き込まれます。インラインコメントでは、コード行の目的またはその機能を説明する必要があります。

インラインコメントの構文は次のとおりです。

print(students) # Print the variable "students"

インラインコメントは、コードの複雑な部分を説明する必要がある場合に役立ちます。また、将来、特定のコード行がどのように機能するかを忘れてしまう可能性がある場合にも役立ちます。

インラインコメントは、チームで作業していて、全員が特定の行を理解していることを確認する必要がある場合にも役立ちます。

他の種類のコメントとは異なり、インラインコメントはたまにしか使用しないでください。これは、インラインコメントが多すぎると、プログラムが読みにくくなるためです。

Pythonマルチラインコメント

Pythonの複数行コメントまたはPythonブロックコメントは、より複雑なコード、または目的がすぐにはわからないコードを説明します。たとえば、ブロックコメントを使用して、外部ライブラリを使用する固有の関数を説明できます。

ブロックコメントはPythonの複数行のコメントであり、その下のコードの一部またはすべてに適用されます。ブロックコメントも、他のコメントと同様に、コメントが議論しているコードと同じレベルでインデントされます。

複数行のコメントの例

Pythonのsort（）関数を説明する複数行の文字列の例を次に示します。

# The sortStudents function will parse arguments via the "student" variable. The
# function simply returns the length of each student's name. We reference the sortStudents
# function in the sort() function later in the code, which iterates over each item in the
# "students" array and executes our sortStudents function.

def sortStudents(student):
	return len(student)

students = ["Nathan", "Alyssa", "Matthew", "Malcolm", "Alexis", "Katie"]

students.sort(key=sortStudents)

コメントは複数行にまたがっており、その下に記述されているコードの目的を説明しています。

一部の開発者はこのコードを理解しているかもしれませんが、他のプログラマーはそれがどのように機能するか、またはなぜそれが書かれたのかについて混乱するかもしれません。ブロックコメントを使用すると、手順全体を説明するのに最適な方法です。ブロックコメントは、開発者にとって目的がすぐにはわからない他のコードを説明するのに役立ちます。

結論

これがPythonでのコメント方法です。コメントを使用すると、自分自身を含むすべての人がプログラムを読みやすくすることができます。

よく書かれたコメントは、コードを追跡するのに役立ちます。後でコードを理解するのに苦労している場合に、後で参照できるレコードを維持できます。

挑戦しますか？プログラムの1つの上部にブロックコメントを書き込みます。このコメントには次のものを含める必要があります：

• あなたの名前
• ファイルを作成したとき
• ファイルの名前
• ファイルの目的

コードを実行してみてください。コメントが原因でプログラムが実行されない場合は、エラーが発生しています。プログラムが通常どおり実行される場合は、おめでとうございます。コメントを正常に作成しました。

このチュートリアルでは、Pythonでコメント、インラインコメント、ブロックコメントを作成する方法について説明しました。また、一部の開発者がテスト用のコメントを作成する方法についても説明しました。これで、Pythonエキスパートのようにコメントを書くことができます！

Pythonプログラミング言語をマスターしたいですか？上位のPythonコース、書籍、学習リソースのサポートについては、包括的なPythonの学習方法ガイドをご覧ください。