コードの書式化
1つのcode、1つのfileを、1つの書類として見たときの、見た目の整然さの話
プログラムなので動くことは大前提だが、その上で見やすいかどうか、コードの見た目に着眼する
縦方向の書式化
1つのfileの長さ、1つのclassの大きさ
少ない行数のほうが理解が容易なのは自明
関数の定義間の行数とか
広すぎても狭すぎても良くない
PHPのdocs用のコメントでは
こんな感じで書くが
php/**
*
*/
$hoge;これだけで最低でも3行使うので、垂直密度が無駄に下がってしまう
コードの垂直密度が下がると、一目の視野に入るべきものが入らなくなってしまう
垂直距離
変数宣言の場所と、実際に使われる場所の距離が大きすぎないようにする
mainの処理を上部に書くの話とか
近い概念の関数は垂直距離が近い位置に書くべき
インスタンス変数は上部にまとめ定義すべきらしい
半分はわかる、半分はわからん
インスタンス変数とそのgetter/setterは近くに定義すべき、とも思う
が、実際そういう実装は見たことがないのでたぶん微妙なんだろう
確かにmethodとmethodの間にインスタンス変数の宣言があっても見落としそうではある
これはclassというものの構造的欠陥だとも思えるが
classというものというか、classのあるあるsyntaxの欠陥
横方向の書式化
自分の書いたものではPurispとかは割とその辺に気を払って書いていた
参考
『Clean Code』 5章