コードの書式化

1つのcode、1つのfileを、1つの書類として見たときの、見た目の整然さの話

プログラムなので動くことは大前提だが、その上で見やすいかどうか、コードの見た目に着眼する

縦方向の書式化

1つのfileの長さ、1つのclassの大きさ

少ない行数のほうが理解が容易なのは自明

関数の定義間の行数とか

広すぎても狭すぎても良くない

PHPのdocs用のコメントでは

こんな感じで書くが

code:php

/**

*

*/

$hoge;

これだけで最低でも3行使うので、垂直密度が無駄に下がってしまう

垂直距離

変数宣言の場所と、実際に使われる場所の距離が大きすぎないようにする

近い概念の関数は垂直距離が近い位置に書くべき

が、実際そういう実装は見たことがないのでたぶん微妙なんだろう

確かにmethodとmethodの間にインスタンス変数の宣言があっても見落としそうではある

classというものというか、classのあるあるsyntaxの欠陥

横方向の書式化

参考