Qiita Advent Calendar 2025 のパイソニスタの一人アドカレ Day6 の記事です。
コメントの書き方と読みやすいコードを書くコツ
Python のコメントは、コードを「未来の自分や他人が読みやすくする」ための道具です。最低限知っておくべきポイントをまとめます。
コメントの基本
1行コメント（#）
# 名前を表示する
print("Alice")
複数行コメント（""")
"""
ここは説明用のコメント
複数行にわたって記述できます
"""
どんなときにコメントを書く？
-
理由を書くとき
「なぜこの処理が必要なのか」を説明する - 意図が伝わりにくいコードの補足
- TODO（あとでやること）を書く
# TODO: 例外処理を追加する
読みやすいコードのコツ
1. 名前を分かりやすくする
user_name = "Alice" # 良い
un = "Alice" # 良くない
2. 1行を短くする
print("Hello, " + user_name + "!" + "今日は良い天気ですね") # 長い
長すぎる場合は変数に分けるとスッキリします。
3. 空行で区切る
name = "Alice"
# 挨拶を表示
print("Hello", name)
4. 一度読んで理解できるコードを目指す
コメントは「補足」であり、「説明書」になりすぎないようにする。
よくあるNG
-
説明になっていないコメント
i = 0 # iに0を代入 ←わざわざ書かなくてよい -
書いたまま放置したコメント
（古いコメントは混乱の元）
まとめ
- コメントは「意図」を書く
- コードは「読まなくても理解できる状態」を目指す
- 過度なコメントは逆効果