コード規約
こちらは unipp の規約です。
コード規約の目的
コード規約がないと、個人個人が好きなようにコードを書くことになってしまいます。 そうならなたいめにコード規約を作ってあります。
名前の付け方
名前は短いコメントだと思えば良い。 名前に情報を詰め込む。
- 明確な単語を選ぶ
- 汎用的な名前を避ける
- 抽象的ではなく具体的な名前を使う
- 接尾語や接頭語を使って情報を付加する
- 名前の長さを決める
- 名前のフォーマットで情報を伝える
- 名前が他の意味と間違えられる事はないだろうかと何度も自問する
- クラス名は CamelCase
- 変数名は先頭小文字のキャメルケース（形容詞＋名詞）
- 定数名は ConstantName
コードを明確にする
- コードの動作を簡単な言葉で同僚にわかるように説明する
- その説明の中で使っているキーワードやフレーズに注目する
- その説明に合わせてコードを書く
コードを小さく保つ
コードが増えるとテストや文書が保守が必要になる。
- 汎用的なコードを作って重複コードを削除する - 未使用のコード、機能を削除する
- プロジェクトをサブプロジェクトに分割する - コードの重量を意識する。軽量で機敏にしておく
ライブラリを活用する
- ライブラリは膨大な設計、デバッグ、修正、最適化、テストを生き延びてきた。ダーウィンの進化を生き延びてきたコードには意味がある。