イマドキのコーディング規約
7年前に、僕が入社したときに教えられたコーディング規約を(特に不満もなく)ずっと使ってきたんだけど、最近になっていくつか変えてもいいかな〜って思える点がでてきました。例えば、、、
- 1行の文字数は120〜130文字ぐらいまでOK(画面が広いので)
- 変更履歴はソースコード上に残さない(バージョン管理システムがあるので)
- 変数名、メソッド名に長い名前をつけて、コメントを少なくする
- スコープが数行以内に限定されるような一時変数(例えばループカウンタ)は、なるべく短い名前をつける
- コメントには、ソースコードの意図/代替案との違い/前提条件のみを書く(処理内容は決して書かない)
- 1度しか呼ばれないプラベートメソッドは作成しない(2回以上呼ぶ事になった時点でメソッドを作成する)
- 代わりにJava/C#などでは、中括弧をつかったブロックでスコープを狭めるようにする(JavaScriptならlet文とか)
- メソッドが長くなるからといって分割しない(一つのまとまった処理が300行ならそのままメソッドにすべき)
- 半角スペースを空ける/空けないの問題は、エディタで強制するか/いっそ自由にするか(規約ではしばれない)
- クロージャ(あるいはC#のDelegate)を推奨する(分かりにくいといって禁止するよりも、使う事のメリットが大)
書き出してみると、まだまだありそうな気がするが。。