コーディング規約

会社独自のものもあれば、オープンソースなどで採用されているものなど、様々なものが知られる。

• ハンガリアン記法
• MISRA-C (Guidelines for the Use of the C Language in Vehicle Based Software)
• NetBSDのコーディング規約
• GNU
• Linuxカーネルコーディング規約
• Google C++ Style Guide

中には、常軌を逸した規約を用いた例もある。

以下はCの規約で、民主的に「非常識」であるとされた一例である。

• 変更する場合は、変更前のコードを全てコメントで残して日付・変更者を記載する
• 関数名は連番
• 引数の使用を禁止し、値の受け渡しはグローバル変数で行なう
• 変数はグローバル変数のみとし、ローカル変数は使用禁止
• 三項演算子は使わない

訳の分からない宗教的な規約は、実用的でないことが多い。

基本的には、バグが少なくなる、保守しやすい、といったことを求めるために規約が存在するはずなので、以下を重点的に押さえれば良いはずである。

• コメントは必ず書く
• インデントはタブでする
• 技巧に走らず、誰が見ても分かるような記述法を使う
• 可能な限り、省略しない

何をもって「技巧」(テクニック)とするかは、そのチームの参加者の力量から随時判断する。

コメントは、どういった趣旨の処理なのかを書く。具体的には、「何をしているのか」ではなく「何故そうなるのか」を書くべきである。

コードを見れば分かるようなコメントは書く必要はないし、書いてはならない。例えば次のような例。

i++; /* iを一つ増やす */

a = 10 /* 変数aに10を代入 */

このような行為は無駄であるのみならず、プログラムの訂正時にコメントの訂正を忘れる恐れがある。

a = 20 /* 変数aに10を代入 */

後から見た者が卒倒する危険性がある。