【初心者向け】コメントの書き方完全ガイド：コードの「どこ」に書くべきか？
山崎講師
こんにちは。ゆうせいです。
プログラムを書くとき、「コメントってどこに書くのがベストなんだろう？」と思ったこと、ありませんか？
実はコメントの位置は、読む人の理解度を大きく左右する重要なポイントなんです！
今回は、コメントの位置とその役割について、実例を交えながら詳しく説明します。
なぜ「コメントの位置」が重要なのか？
コードは「読む人」にとってのコミュニケーション手段です。
未来のあなたや他の開発者が読むときに、一目で意図がわかるかどうかがカギ。
例えるなら、説明なしの地図と案内付きの地図。
後者のほうが迷いませんよね？
基本の位置：コメントは“直前”に書くのが基本
関数・処理ブロックの前に
# ユーザーからの入力を受け取って、名前を標準出力する
name = input("名前を入力してください：")
print(f"こんにちは、{name}さん！")
こうすることで、「これから何が行われるのか」が事前にわかります。
変数の初期化の前
# スコアの初期値を0に設定
score = 0
変数の役割が一目でわかります。
横（行末）に書くべき場合は？
短いコメントや補足説明
x = 10 # 初期値は10で固定
このように「簡単な注釈」は横に書いてもOK。ただし、行が長くなりすぎないよう注意！
関数内で処理が長くなるときは途中にも
処理が数行に渡ると、途中で「何してるんだっけ？」となることがありますよね。
そんなときは処理の区切りでコメントを入れましょう。
# ユーザーの入力を受け取る
name = input("名前を入力してください：")
# あいさつを表示
print(f"こんにちは、{name}さん！")
避けるべきNGなコメント位置
コードの後ろに長文の解説
print("Hello") # この関数はPythonにおける標準出力関数で、ユーザーに文字列を表示します。主にデバッグなどにも使用されます。
これは読む人の目が迷います。長い説明は上に分けて書きましょう。
図でまとめる：コメント位置のベストプラクティス
| コメント位置 | 向いている内容 | 注意点 |
|---|---|---|
| 行の前（上） | 処理の目的・役割 | 基本の位置！ |
| 行末（横） | 短い補足説明 | 長文にならないよう注意 |
| 行の後ろ数行 | 処理のまとまり | 処理が長いときに有効 |
| 行の下 | 避けるべき | 意図が伝わりにくい |
結論：コメントは「未来の自分と仲間への手紙」！
コメントは「読み手ファースト」で場所を選ぶのがコツです。
- 基本は「処理の前」に
- 横は短く、補足的に
- 処理が長いなら途中でもうまく使う
次に学ぶべきは？
コメントの内容の質も大切です！
次は「どんなコメントが役に立つのか」「悪いコメントとは何か？」を学びましょう。
必要なら、リクエストしてくれたら詳しく解説しますね！
セイ・コンサルティング・グループの新人エンジニア研修のメニューへのリンク
投稿者プロフィール
- 代表取締役
-
セイ・コンサルティング・グループ株式会社代表取締役。
岐阜県出身。
2000年創業、2004年会社設立。
IT企業向け人材育成研修歴業界歴20年以上。
すべての無駄を省いた費用対効果の高い「筋肉質」な研修を提供します！
この記事に間違い等ありましたらぜひお知らせください。
