第6章:コメントは正確で簡潔に
概要
前章では、コメントで書く内容の部分に関して解説していたが、本章ではその内容をどのように書くべきかという点を解説してくれている。
まとめ
小さな領域にできるだけ情報量を詰め込み、簡潔に正確にコメントをするためのコツを説明していた。
学んだ点
・コメントは領域に対する情報の比率が高くなければならない。要するに、画面にコメントの領域を取られるため正確かつ簡潔なものでなければならない。
・「その」「あの」のような曖昧な代名詞を使用しないようにする。
・あいまいな代名詞を避ける。
・歯切れの悪い文章を変更する。例えば、「優先度を変える」よりも「優先度を高める」の方が何をどうするといったように意図がわかりやすい。
・コードの動作をそのまま書くのではなく、そのコードを書いた意図を記しておく。
・情報密度の高い言葉を使う。
・コメント後長くてくどいと感じたら、短縮して意図が伝わるか考えてコメントを編集する。要するに、多くの意味が詰め込まれた言葉や表現を使って、コメントを簡潔に保つ。
感想と振り返り
そもそも、普段開発に関わる際にコメントを使用する習慣がなかったので、これを機に適切にコメントを付けられるように試行錯誤したいと思った。また、その際はこの章で解説してくれていた通り無駄のない簡潔で正確なコメントを書けるように心がけたいですね！既存のコメントにも目を向けていきます！