コーディング規約 - NT-Dentsu/dentsuTools GitHub Wiki
変数の命名規則
- キャメルケースとする。
- ローカル変数名は、できる限り短くする。
コーディングスタイル
- 字下げはスペース4文字とする。 →[.editorconfig]にて設定済み。
- マジックナンバーは原則使用禁止とする。 →原則から外れるパターンとして、[0]という数字を[0]という意味で使用するような場合は、定数化する必要はない(Const INT_0 = 0 のような定数は不要)。
コメント
- 各クラスには、制作者及び更新日を記載する。
- 各メンバには、役割を簡単に記載する。
- 各メソッドには、簡単な説明を記載する。
- 制作者以外の人間が更新した場合、その部分には署名及び更新日時を入れる。 →クラスの制作者に自分の名前を追記し、更新日時も変更する。