Pythonでコードブロックをコメントアウトする方法

コメントは、Pythonで作業する際に最も有用なツールの一つです。それらは、実行を邪魔しないように、コードのブロックの背後の論理、決定、目的をガイドします。コメントは、コードをより読解しやすく、メンテナンス可能にし、チーム設定での協力を促進します。

このチュートリアルでは、Pythonで複数行のコードをコメントアウトする2つの効果的な方法について詳しく説明します。これにより、コードが良く文書化され、容易に理解できるようになります。

Pythonでのブロックコメントがなぜ重要か？

コメントは、Python学習の旅の最初のコンセプトの一つにしばしばなります。それらは、特定のコードスニペットの背後の意図について有用な文脈を提供します。スクリプトがなぜそのように動作するかについての明確さとコンテクストを提供します。自分のスクリプトで常にコメントを使用するべき理由はいくつかあります。以下はその4つです：

• 文書化：コメントは、関数、クラス、またはコードのブロックの目的を説明する文書形式として機能します。これは、論理がすぐには明らかでない複雑なアルゴリズムに特に有用です。
• 読解性：よくコメントされたコードは、より読みやすく理解しやすいです。これは、時間を経て再びコードを訪れたときに非常に重要です。
• デバッグ：一時的にコードの一部をコメントアウトすることは、バグを隔離して特定するための一般的な実践です。
• 協力: チーム環境では、コメントがコードをより共有可能で理解しやすくし、よりスムーズな協力とコードレビューを促進します。

Pythonでの一行ブロックコメントの使用

複数行をコメントアウトする前に、一行コメントの基本を始めましょう。Pythonでは、一行コメントはハッシュ記号(#)で始まり、Pythonインタプリタはその行に続くすべての内容を無視します。一行コメントを作成するには、以下の手順に従ってください：

1. 配置: #記号を行の先頭にまたはコードの右側の同じ行に配置します。コメントは、説明するコードの上、コードの右側、または独立して配置できます。
2. 内容: #記号の後ろにコメントを書きます。これには、次の行のコードの説明、将来参照するためのメモ、またはコードに関連する有用な情報が記述できます。

# 次の行のコードを説明する一行コメントです
print("Hello, world!")  # これはコンソールにメッセージを出力します

方法1: 複数の一行#を使用したコメント

Pythonでコメントを行う最も簡単な方法は、#記号を使用することです。#記号を使用すると、その後の行全体をコメントアウトすることができます。Pythonにはブロックコメントの特定のスyntaxはないですが、各行を個別にコメントアウトするためには複数の#記号を使用することができます。以下の手順を実行するだけです。

1. コードブロックを識別する: まず、コメントアウトしたいコードブロックを識別します。これは、関数、ループ、あるいは、ディスABLEまたは説明したいコードのセグメントになります。
2. 各行をコメントアウトする: コメントアウトしたい行の先頭に#記号を置きます。これにより、Pythonインタープリタがこれらの行を実行時に無視します。

以下は例です。

# 各行を個別にコメントアウトする例
# def example_function(name):
#	# この関数は"Hello "と入力された名前をプリントします
# 	print("Hello", name)

Pythonブロックコメント方法2: 3重引用符文字リテラルを使用してコメントする

多行コメントを行う替代手段として、三つの引用符の文字リテラル（”’ ”’または””” “””）を使用することがあります。正式なブロックコメントではありませんが、これらの文字リテラルは、特に多行コメントやdocstringsにはよく使用されます。三つの引用符の文字リテラルを使用するには、コメントアウトしたいコードブロックの前後に”’または”””を置くだけです。以下のようになります:

'''
def example_function(name):
	print("Hello", name)
'''

三つの引用符の文字リテラルは、Python関数のドキュメント化に最も一般的に使用されます。たとえば:

# Create example_function()
def example_function(name):
	'''
	This function takes as input a name, and returns a salutation to the name in the form of "Hello name"
	'''
	# Print the output 
	print("Hello", name)

これらの三つの引用符の文字リテラルは、ドキュメントとして称されることが多い—それについては私たちのdocstrings教程でより詳細に学ぶことができます。