コメントの書き方
Pythonを学ぶときに必ず知っておきたいのがコメントの書き方です。
コメントとは、プログラムの中に書く「メモ」のようなもので、コードの実行には影響しない説明文のことを指します。
なぜコメントが大事なのかというと、コメントを入れることで コードの可読性（読みやすさ）が向上し、後から見たときに理解しやすくなる からです。
特に初心者のうちは、自分自身が理解しやすいようにコメントを書く習慣をつけておくと、学習のスピードも上がります。
今回は、Pythonにおけるコメントの基本的な書き方と活用方法を、実際のサンプルコードを使いながらわかりやすく解説します。
Pythonのコメントには2種類ある
Pythonには主に2種類のコメントがあります。それは、行コメントと複数行コメントです。
それぞれについて解説します。
1. 行コメント（#を使う）
行コメントは、行の先頭または行の途中に#（シャープ）をつけて記述します。
この #以降に書かれた内容は、Pythonインタプリタ（Pythonを実行する仕組み）によって無視される ため、プログラムの動作には影響しません。
以下は、コメントを記述したコードです。
# これは行コメントです
print("Hello, World!") # ここで挨拶を表示
上記のコードでは、#の後に続くテキストはコメントとして扱われ、プログラムの実行には影響しません。
このように、行コメントは処理の説明を短く書くときに便利です。
2. 複数行コメント（ドキュメンテーション文字列）
長い説明をしたいときや、関数やクラスの説明を加えたいときは複数行コメントを使います。 Pythonでは '''（シングルクオーテーション3つ）または """（ダブルクオーテーション3つ） で囲むことで、複数行のコメントを書くことができます。
この書き方はドキュメンテーション文字列（docstring）と呼ばれ、特に関数やクラスの説明に使うのが一般的です。
def greet(name):
'''
この関数は、指定された名前を使って挨拶を返します。
:param name: 挨拶する相手の名前
:return: 挨拶の文字列
'''
return f"Hello, {name}!"
print(greet("tanaka"))
上記のgreet関数のドキュメンテーション文字列は、関数の役割や引数、返り値についての説明を提供しています。これにより、他の開発者がコードを理解しやすくなります。
コメントを書くときのベストプラクティス
ただコメントを書けば良いというわけではありません。 実際の現場では、次のようなルールを意識してコメントを書くと良いでしょう。
- 明確で簡潔に: コメントは、コードの意図や目的を明確にするために書かれます。冗長なコメントは避け、簡潔に説明しましょう。
- 最新の状態を保つ: コードを変更した場合は、コメントも更新してください。古いコメントは誤解を招く可能性があります。
- 重要な部分に焦点を当てる: すべての行にコメントを書く必要はありません。特に複雑な部分や、他の人が理解しにくい部分に焦点を当ててコメントを追加しましょう。
コメント練習：円の面積を求めるプログラム
次に、プログラムにコメントを付けて練習してみましょう。
以下のような円の面積を計算する関数があったとします。
def calculate_area(radius):
pi = 3.14
area = pi * (radius ** 2)
return area
result = calculate_area(5)
print(f"半径5の円の面積は: {result}")
このプログラムにコメントをつけると以下のようになります。
def calculate_area(radius):
'''
円の面積を計算する関数
:param radius: 円の半径
:return: 円の面積
'''
pi = 3.14 # 円周率
area = pi * (radius ** 2) # 面積の計算
return area
# 半径5の円の面積を計算
result = calculate_area(5)
print(f"半径5の円の面積は: {result}")
実際の開発現場よりも、大げさにコメントを記述していますが、コメントを書くことでどのようなプログラムなのかをわかりやすくしています。
まとめ
このようにコメントを適切に使用することで、コードの可読性が向上し、他の人や自分自身が後で見たときに理解しやすくなります。
コメントは、プログラミングにおいて非常に重要な要素ですので、積極的に活用しましょう。
