コードの10戒

長いコーディング標準は、読むのも守るのもメンテするのも大変です。
なので、短いけど守ってほしい事と理由を犬の10戒の真似をしてまとめてみました。

1.名前は分かりやすいものにしてください。
わたしをよく知ってもらいたいのです。
だから名前は分かりやすいものにしてください。
メソッド等の名前が文章になってもかまいません。何をしようとしているのかを明示してください。
変数の名前も、その存在理由が分かるような名前にしてください。

2.わたしは、共通やcommonという名前が自分に含まれることを嫌います。
変数もメソッドも定数もクラスも役割を持ったあるべき場所に配置してください。

3.わたしが動作するための条件を指定してください。
わたしは動作するための条件を知ってもらいたいのです。
わたしが動作するための条件を前段階であらかじめ記述してください。

4.スコープは最小にしてください。
わたしは嫌われたくありません。
複数の問題が同時に存在していると人は混乱しやすくなり、わたしを嫌います。
変数のスコープも処理のスコープも最小になるように心がけてください。

5.わたしは太ると不健康になります。
不必要なコードを「将来のために」と作らないでください。

6.わたしは、できるだけ理解されやすいままでいたいと願っています。
だからチューニングをする前に非機能要求を定めて、計測してください。
そして、本当に必要なときだけチューニングしてください。

7.わたしをテストしてください。
わたしはあなたの作ったとおりにしか動きません。
あなた自身が正しく作ったかどうかをテストしてください。

8.思い通りに動かないとわたしを罵る前にわたしがそうなる原因が何かないか、あなた自身に問いかけてください。
繰り返しますがわたしはあなたが作ったとおりにしか動作できないのです。

9.保守で修正する前にわたしの事を理解してください。
理解したうえで修正するようにしてください。
わたしは秩序を乱されることが苦手なのです。

10.コーディング標準を守ってください。
わたしはとてもデリケートな存在です。
コーディング標準が守られていないと、存在意義がなくなってしまいます。
だから自分ルールでの無秩序なコーディングはやめてください。