LINEで現役エンジニアに直接質問してみよう!登録無料

プログラミング初心者がプログラムに良いコメントを書くためのポイントを解説

プログラミングの「コメント」とは?

コメントの使い方は2つある

コメントの使い方は2つある

  • なぜ、どうする、今後、改善方、改善するのか、概要、方針等を記述する
  • コメントアウト、アンコメントしてプログラムをデバックする

コメントのダメな使い方

  1. 「どういう処理をするか」を逐次コメントとして記述する
  2. コメントアウトしたままプログラムを使い続ける

コメントを書かなくても分かるプログラムが一番よい

プログラムはコメントを書かなくても分かる書き方が一番いいです。

良いコメントを書く4つのポイント

  • どうしてこのようなプログラムにしたのか?
  • 今後、この部分をどう改善していきたいのか?(心残り)
  • 実装でやりのことした事(TODO)
  • 何を担当している処理なのか?
この記事を書いた人

自身がプログラミングを独学で勉強し始めて躓いた経験を元に、これから勉強をする人に向けに「イラスト多めでわかりやすい記事」にこだわって情報を発信しています。

現在はフルスタックエンジニアとしてサービス開発などのお仕事をしています。