山傘のプログラミング勉強日記[Java & Unity]

プログラミングに関する日記とどうでもよい雑記からなるブログです。

リーダブルコードを読む その3

リーダブルコード

 今日は6章を読みました。2章から6章までが第1部の「表面上の改善」として書かれています。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

 

 

6章 コメントは正確で簡潔に

コメントは簡潔で分かりやすいように記述する。

コメントで代名詞を使う場合は、代名詞が明確になるように記述する。

関数の動作を記述するとき、入出力の実例を書いてあると理解度を高められる。

コードの意図を書く場合は、動作そのものを詳細に記述するのではなく、情報を集約したものを記述する。