コーディング規約 - Neptune Wiki - Neptune

コーディング規約

インデント

インデントは4タブとします。

中括弧、スペース等

特に規制は設けませんが読みやすいようにお願いします。 可読性に問題がなければスペースはつめて構いませんし、 逆に可読性に問題がある場合は、スペースを詰めた方がよい場合もあります。

命名規約

基本的にハンガリアン記法にのっとります。 ただし、ほんの数行の限られた範囲でしか使用されない 変数であれば「work」のような名前を使用しても構いません。

修正の明示

ソースコードを修正した場合は、その箇所に以下の書式のコメント文を挿入し、 修正したことが人目で分かるようにしてください。

書式：

//	yyyy/mm/dd <<名前>>  <<簡単な概要>>

例：

//	2008/09/12 myun2  ポインタのチェックを追加

修正前のコードの保存

本プロジェクトでは、バージョン管理システム（Subversion）を用いているため、 修正前のコードに戻したり、参照することは可能ですが、 修正後のコードになんらかの問題があった場合に、 手早く、そして確実の元のコードへ戻す事が出来るように、 出来るだけ修正前のコードを保存しておくようにお願いします。

（特に、元のコードが他人の書いたコードであった場合、 修正後のコードは元のコードを書いた人の意図しないものである可能性があります。 なので自分の書いたコードで無い限り、修正前のコードを残しておいてください。）

例）修正前：

int a = FuncA(b + c);

例）修正後：

//	2008/09/12 myun2  FuncAではなくFuncBを使うように
//int a = FuncA(b + c);
int a = FuncB(b + c);

もし、貴方が確実に、そのコードを元に戻す事が無いことを保障できるならば、 修正前のコードを削除してしまっても構いません。 ただし多くの場合、「プログラマーの予期しないところからバグは上がってくる」ので （と言うか予期出来るくらいならそのバグは既に解決されている筈・・・）基本的に 元のコードを保存しておくことをお勧めします。

ただし、これを繰り返していくと、コードの可読性が落ちていくのは明白です。 余りにコメント化されたコードが多く、読み辛く、 そしてその新しいコードに変更されてから十分な期間が経過し もう元のコードに戻すことは無いだろうと判断された場合には、 保存していたコードは削除してしまっても構いません。