コーディング規約
黄金律 「既存のコードをお手本とする」
コーディング規約とは、コード(プログラム)の記述スタイルのためのガイドラインとなるものである。
コーディング規約に従ったコードを作成することで、次の効果を得ることができる。
可読性の向上。
コーディング規約では、コードの記述スタイル(形式)を定義する。
記述スタイルに従ってコードを作成することにより、そのコードから作成者の癖を排除することができ、コードの可読性を向上することができる。
バグの排除。
コーディング規約では、バグの作り込みにくさをコントロールするための施策を盛り込むこともある。
例えば、命名規則や、リスクの高い言語仕様を避けるためのルールを用意し、それに従いコードを記述することで、バグの混入の防止につながる。
コーディング規約は、対象となる言語(例えば、アセンブラ、C言語、など)により大きく変わる。
その理由として、各言語の仕様の違いがあるからである。
なお、コーディング規約は、コードを作成する前には準備をしておくことが望ましい。
コードを作成してから(あるいは、その途中で)コーディング規約が作られると、規約にあわせて再度コードを作成し直さなくてはならず、余計な時間をかけることになる。
CS : coding standards
コードの統一化
コーディング規則
Comment conventions
Indent style conventions
Naming conventions
Programming practices
Programming principles
Programming rules of thumb
Programming style conventions
Programming level coding applications
ソースコード(source code)
スタイルガイド(Style Guide)
用字用語の統一
読みやすさ
重複コード(duplicate code)
字下げスタイル、インデントスタイル(Indent style)
コメント付け
コメントの量と質
命名規則(Naming conventions)
コーディング標準(Coding Standards)
コードオーディタ(code auditor) -- コーディング規約のチェックツール…らしいけど、そういうツールは見たことがない。
目標による管理(MBO : management by objectives) -- 目的と手段の取り違いに注意。
設計思想 -- 思想が統一されているプログラムは見通しがいい
プログラミングパラダイム (programming paradigm)
Comparison of programming languages (syntax)
Indent style
List of tools for static code analysis
MISRA C
Programming style
Hungarian Notation