Python 逆引き集 | Python基礎・実行環境:コメントを書く

Python Python
スポンサーリンク
スポンサーリンク

Python基礎・実行環境

Pythonを学び始めた多くの初心者が最初に戸惑うポイントのひとつが「コメントを書く」という作業です。 コメントはコードの動作には影響しませんが、読みやすさ・保守性・安全性を大きく左右する重要な要素です。 ここでは、Pythonのコメントを「なぜ必要なのか」「どう書くのが正しいのか」を、例題やテンプレートを交えながら丁寧に解説します。

コメントとは何か

コメントとは、Pythonインタープリタが無視する“説明文”のことです。 コードの中に書いても実行されず、プログラムの動作には一切影響しません。

コメントが果たす役割

  • コードの意図を説明する
  • なぜその処理が必要なのかを残す
  • 後から読む人(未来の自分を含む)へのメッセージ
  • バグ調査や保守の効率を上げる
  • セキュリティ上の注意点を明記する

コメントは「コードの補助」ではなく、コードの一部です。 プロの現場では、コメントの質がそのまま開発者の評価につながることもあります。

Pythonのコメントの書き方(基本)

1行コメント(#)

Pythonでは、# を使って1行コメントを書きます。

# これは1行コメントです
print("Hello")  # 行の途中にも書けます
Python

複数行コメント(””” “””)

Pythonには正式な複数行コメント構文はありませんが、文字列として書いて無視させる方法が一般的です。

"""
この部分は複数行コメントとして扱われます。
処理の説明や注意点をまとめて書くときに便利です。
"""
print("Hello")
Python

ただし、複数行コメントは「文字列として存在している」扱いになるため、関数の先頭に書くと“docstring”として扱われる点に注意が必要です。

コメントを書くときの基本ルール(重要)

ルール1:コードの“意図”を書く

悪い例:

# 変数xに10を代入する
x = 10
Python

これはコードをそのまま説明しているだけで、読む価値がありません。

良い例:

# 最低購入数の初期値(仕様で10と決まっている)
x = 10
Python

「なぜ10なのか」という意図が書かれているため、後から読む人が理解しやすくなります。

ルール2:セキュリティ上の注意点を書く

セキュリティスペシャリストとして強調したいのは、危険な処理には必ず注意書きを残すことです。

# ユーザー入力をそのままevalに渡すのは危険(コード実行のリスク)
# TODO: 安全なパーサーに置き換える
result = eval(user_input)
Python

コメントは「安全なコードを書くための防護壁」にもなります。

ルール3:未来の自分へのメッセージを書く

コードを書いたときは理解していても、1ヶ月後には忘れています。 コメントは「未来の自分へのメモ」です。

# この処理はAPIの仕様変更に弱い。2026年Q4に再確認すること。
Python

ルール4:不要になったコメントは削除する

コメントは増え続けると逆に読みづらくなります。 「役目を終えたコメント」は積極的に削除しましょう。

コメントの具体例(初心者向け)

例1:計算処理の説明

# 税率は将来変更される可能性があるため変数で管理
tax_rate = 0.1

# 税込み価格を計算
price_with_tax = price * (1 + tax_rate)
Python

例2:条件分岐の意図

# 80点以上なら優秀とみなす(仕様書の定義)
if score >= 80:
    print("Excellent")
Python

例3:ループの目的

# 商品リストを1つずつ表示する
for item in items:
    print(item)
Python

コメントの悪い例と改善例

悪い例(コードの説明だけ)

# リストをループする
for x in data:
    print(x)
Python

改善例(意図を書く)

# デバッグ用:受け取ったデータをすべて表示して確認する
for x in data:
    print(x)
Python

コメントテンプレート(そのまま使える)

処理の目的を書くテンプレート

# 【目的】〇〇するための処理
Python

注意点を書くテンプレート

# 【注意】〇〇のため、この処理は変更しないこと
Python

TODOを書くテンプレート

# TODO: 〇〇を改善する(期限:2026年Q4)
Python

セキュリティ注意テンプレート

# 【SECURITY】〇〇は危険。入力チェック必須。
Python

コメントを書く練習問題(初心者向け)

問題

次のコードに、適切なコメントを書いてみてください。

discount = 0.2
price = 1200
final_price = price * (1 - discount)
print(final_price)
Python

模範解答

# 割引率(キャンペーン期間中は20%)
discount = 0.2

# 元の価格
price = 1200

# 割引後の価格を計算
final_price = price * (1 - discount)

# 計算結果を表示
print(final_price)
Python

まとめ

コメントは「コードの説明」ではなく、コードの意図・背景・注意点を伝えるための重要な情報です。 初心者のうちから「良いコメントを書く習慣」を身につけておくと、後々の開発効率が大きく変わります。

タイトルとURLをコピーしました