Pythonのコメントは、コード内に追加された説明やメモであり、プログラムの可読性や理解を向上させるために使用されます。Pythonのインタープリタはコメントを無視しますので、コメントはコードの実行に影響しません。
Pythonのコメントは、行コメントとブロックコメントの2つのタイプがあります。
1. 行コメント
行コメントは、行の最初から # 記号が現れるところから始まり、その行の終わりまで続きます。行コメントは、その行に追加の説明を追加したり、一時的にコードを無効にしたりするために使用されます。
# これは行コメントです x = 5 # この行の後ろにも行コメントを追加できます
2. ブロックコメント
ブロックコメントは、トリプルクォート (”’ や “””) を使用して、複数行にわたるコメントを作成します。通常、関数やクラスの定義の直前に、その機能や目的に関する説明を追加するために使用されます。
''' これは 複数行の ブロックコメントです '''
コメントは、他の開発者や自分自身が将来のコードの理解やメンテナンスを容易にするのに役立ちます。また、コードの特定の部分の意図や機能を説明するためにも使用されます。
以下はコメントの例です:
# daiichi.dev この関数は2つの数値を加算する def add_numbers(a, b): return a + b ''' これは 複数行の コメントです daiichi.dev ''' result = add_numbers(5, 10) # add_numbers関数を呼び出して、結果をresultに代入する
このコードは、Pythonのコメントの概念とその例を示しています。
# この関数は2つの数値を加算する
: これは行コメントで、関数add_numbers
の定義の直前に関数の目的を説明しています。def add_numbers(a, b):
: これは関数add_numbers
の定義です。この関数は2つの数値を加算して返します。''' これは 複数行の コメントです '''
: これはブロックコメントで、複数行にわたるコメントを定義しています。このコメントは複数行コメントの例を示しています。result = add_numbers(5, 10) # add_numbers関数を呼び出して、結果をresultに代入する
: これは行コメントで、add_numbers
関数を呼び出してその結果をresult
変数に代入する行を説明しています。
コメントはコードの理解を助けるために役立ちます。特に他の開発者や将来の自分のためにコードを書く場合には、適切なコメントを追加することが重要です。