Pythonのコメントの書き方

コメントは、コードの内容を説明したり、なぜそのコードを書いたのかを補足するために使用します。Pythonではシンプルな記述方法でコメントを追加することができます。

---

1. コメントの書き方

• Pythonでは、# を使って1行コメントを書きます。
• コメントは実行されないため、コードの説明やメモとして使えます。

例

# これはコメントです
print("Hello, World!")  # この行もコメントとして説明を追加

出力

Hello, World!

---

2. コメントを書くときのショートカット

• VSCodeでは、⌘ + / を使って選択したコードを一瞬でコメントアウトできます。
• ショートカットを使うことで、複数行のコメントも効率よく追加・解除できます。

---

3. 実際の開発でコメントを書く場面

1. なぜそのコードを書いたのか説明する場合

• 特定の処理の意図や目的を記述する。

例

# この変数は商品の在庫数を保持する
stock_count = 100

2. わかりにくい処理を補足する場合

• 複雑なロジックや、第三者が理解しづらいコードに補足を記述する。

例

# リスト内包表記を使用して、偶数だけを抽出する
even_numbers = [x for x in range(10) if x % 2 == 0]

3. 一時的にコードを無効化する場合

• テストやデバッグのため、一部のコードをコメントアウトする。

例

# print("This line is commented out")
print("This line will run")

---

4. コメントを書くときの注意点

1. 必要な場合にのみコメントを書く

• わかりやすいコードを書くことを優先し、必要最小限のコメントにとどめる。

悪い例

x = 10  # xに10を代入する

• 上記のようにコメントが不要な場合は書かないようにする。

2. 読みやすいコメントを書く

• 長すぎるコメントや曖昧な説明は避け、簡潔かつ明確に記述する。

---

5. コメントを書くべきコードの例

• プロジェクトの規模が大きくなる場合
  • 他の開発者がコードを読んだときに、意図がわかるように補足する。

例

# クライアントから要求されたレポートデータを生成する
def generate_report(data):
    # データをフィルタリングして、必要な情報だけを抽出する
    filtered_data = [item for item in data if item["active"]]
    return filtered_data

• 未来の自分へのメモとして
  • なぜこのアプローチを取ったのか記録しておく。

例

# このロジックはAPIの古い仕様に対応するために必要
response = legacy_api_call()

---

6. コメントが不要になる工夫

• コメントを減らすために、コード自体をわかりやすく書く。
• 変数名や関数名を適切に命名することで、コメントの必要性を最小限にする。

コメント不要の例

# 悪い例
x = 10  # 価格を表す

# 良い例
price = 10

---

7. まとめ

• コメントは「コードを補足する説明」として非常に重要です。
• ただし、コメントに頼りすぎず、コード自体をわかりやすく書くことを心がけましょう。
• ショートカット（例: ⌘ + /）を活用すると、効率よくコメントを追加できます。

---