「ビューティフルコード」 32章 働くコードの「整ったコードの７か条」を紹介します。
#は、投稿者(青木)の意見。
32章の著者 Laura Wingerd、Christopher Seiwald
原文
http://www.perforce.com/resources/white-papers/seven-pillars-pretty-code
サンプルコード
ftp://ftp.perforce.com/jam/src/make.c
■既存のスタイルに溶け込むこと
コードを変更するとき、既存のスタイルで書くこと。
■「本のよう」であること
1行の長さを短くする。短い行ほど理解しやすい。 経験的に80文字がよい。
■コードをブロックに分けること
■コードにコメントをつけること
# サンプルコードはstep 1、step 2と大ブロックに分け、step 1の中をstep 1a、step 1b と小ブロックに分けています。
■ごちゃごちゃにしないこと
繰り返し参照される変数名を短くする。
元のコードをコメントで残すのではなく削除する。元のコードはSCMを見ればよい。
何を変更したかをコメントしない。変更履歴はSCMを見ればよい。
# gitやバグ管理ツールを使うと、不要コードや不要コメントを思い切って削除できるようになります。
■似たものは似ているように見えるようにすること
■インデントを克服すること
インデントが深いと読みにくくなる。
しかし、最大の落とし穴は「入れ子」であり、「入れ子」になったコードは理解しにくい。
