コーディング規約 - 変愚蛮怒 Wiki - 変愚蛮怒

コーディング規約

実質的指針になったものもいくらかあるのでまとめてみる。

• ルートディレクトリ内の .clang-format に応じた自動整形を原則推奨する。
• コメントについてはDoxygenの文法に従った、関数、変数、構造体の解説がある程度行われていることが望ましい。
• チケット #40944 に倣い、forブロック内でのみ完結するループ変数はfor内で宣言してしまうことが望ましい。
• 変数名については英語やその略称を用い、日本語ローマ字は使わない。
• switch文についてfall throughを使ってもよい。
  • ただし、break;のつけ忘れによる意図しないfall throughを防ぐため、gccでコンパイルするときは-Wextraも付加して警告を行うよう設定している。これにより、意図しないfall throughを防ぐと共に、明白にこれを行いたい場合はコメントに /* Fall through */ とつけてこの警告を抑制すること。