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

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

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

リーダブルコード

 今日はリーダブルコードの4章と5章を読みました。

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

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

 

 

4章

コードのレイアウトについて。

適切なインデントや改行を行うことでコードの見た目を整えることが見た目の美しさにつながる。インデントや改行の位置を一貫性のあるものにして、コメントの位置も気を付ける。

変数の並びも意味のある順番に並べる。

 

5章

コメントについて。

コードを見てすぐにわかるコメントは必要ない。また、読み手を意識してコメントを書く。

コードを書いたときの自分の考えをコメントに記す。例えば、アルゴリズムAを使わずにアルゴリズムBを使った理由とか。

コードの改善のためのコメントを記す。コメントの記法として、「TODO: あとで改善」などがあるので、利用するとよい。

コード全体の説明を書くと、新しくコードを読んだ人が分かりやすいようになる。

コメントを書くことに慣れてない人は、こまめにコメントを書いていき、修正をすることで質があがっていく。