通信用語の基礎知識 IPv4
戻る
全国のICカードこれひとつ

コーディング規約

辞書:電算用語の基礎知識 プログラミング設計編 (PTPROGE)
読み:コーディングきやく
品詞:名詞
2008/07/26 作成

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

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

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

代表例

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

  • ハンガリアン記法
  • 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を代入 */

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

用語の所属
コーディング

コメントなどを投稿するフォームは、日本語対応時のみ表示されます


KisoDic通信用語の基礎知識検索システム WDIC Explorer Version 7.04 (07-Mar-2021)
Search System : Copyright © Mirai corporation
Dictionary : Copyright © WDIC Creators club