【プログラミング入門】コメントに書く内容|意識することはたった1つ!

初心者向け
  • コメントに何を書けばいいのか困っている
  • なにも考えずにコメントを書いている

こんな人は読んでください。コメントを勉強する人は少ないですし、現場レベルでも軽視されがちです。しかし、正しくコメントを書くようにしなければ可読性を落としたり、バグを埋め込む原因にもなり得ます。

基本的にコメントはあることを意識するだけでイケてるコメントに大変身します。

では早速、コメントに書く内容についてみていきましょう。

コメントは意味のある内容を書く

まずは結論。意味のあるコメントを書くことを心掛けましょう

コメントは様々なシチュエーションで利用されますが、基本的にソースコード中に書くコメントで意識して欲しいのが「意味のあるコメントを書く」です。

また、意味のないコメントは一部例外を除いて書くべきではありません。それは、意味のないコメントが溢れかえると、コードが読みにくくなるからです。最悪の場合、それが原因でバグを埋め込むことに繋がるので気を付けましょう。

では続いて、「意味のあるコメント」と「意味のないコメント」について、具体的なものを見ていきましょう。

意味のあるコメントとはコードの読み手を助けているかどうか

意味のあるコメントはコードの読み手を助けているかどうかで判断できます。

例えば下記のようなコードです。

// 1.意味のあるコメント
// XXXという理由で、ここではXXXしている。

// 2.意味のないコメント
// XXXにXXXを代入する。

何となく分かっていただけましたか?

意味のあるコメントはコードを読んだだけでは分からない、どうしてそういうコードになっているのかについて理由を述べています。

対して、意味のないコメントは、「うん、で?」となり、コードを読めば分かることが書かれています。

さいごにまとめ

  • 意味のあるコメントを書くことを心掛ける。意味のないコメントは可読性を落とし、バグを埋め込む原因になり得る。
  • 意味のあるコメントを判断するポイントは、コードの読み手を助けているかどうか。

簡単ですが以上です。

初心者からすぐ実践できることなので明日から書くコメントは本記事に記載の内容を意識して書いてみて下さい。

より詳細な情報を知りたい方はリーダブルコードという本がオススメです!ソースコードは一度書いて終わりではありません。どうしたら読みやすく保守しやすいコードを書けるのかについて知ることが出来る一冊です!

また、下記のCleanCodeという本もオススメです。
どうしたらキレイで読みやすいコードを書けるようになるのか、テクニックや考え方を紹介した一冊です。

では最後まで読んでいただきありがとうございました!

コメント

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