コーディング規約 - 通信用語の基礎知識

プログラムを記述する(コーディングする)にあたり、守るべき記述方針のこと。

概要

大勢が参加するプロジェクト等においては、記述方法に一定の方針が定められていることが多い。これをコーディング規約という。

これを全員が守れば、誰が書いても大体似たような書き方となり、保守性能(メンテナンス性)が高まるとされている。

特徴

代表例

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

珍例

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

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

まともな例

基本

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

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

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

コメント

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

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

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

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

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

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

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

リンク

用語の所属