「C言語のコーディング規約による保守性の向上」

（1）

読みやすい

（2）

わかりやすい

（3）

統一されている

（1）

可読性に優れており、読みやすい

（2）

変数などのネーミングが適切である

（3）

ロジックがシンプルである

（4）

無駄なコードの重複が無い

（5）

インターフェースが直感的である

//--------------------------------------------------------------------------------
//      ファイル名      :       APPMT.C
//      概要            :       Application (Multi Task)  startup
//      詳細            :       アプリケーション (マルチタスク) スタートアップ
//                                      main task を起動する
//      履歴            :       2006/06/07      UserName                新規作成
//--------------------------------------------------------------------------------   

//----------------------------------------------------------------------------
// 関数名       ：main
// 概要         ：
// 戻り値       ：なし
// 引数         ：int argc
//              説明    
// 引数         ：char *argv[]
//              説明    
// 引数         ：char *envp[]
//              説明    
// 作成         ：2006/06/07    UserName
//----------------------------------------------------------------------------
void main(int argc, char *argv[], char *envp[])  

メンテナンスの必要に駆られて解析をおこなう場合、ソースコードを解析するのにキーワード検索は有効です。しかし、コメントのスタイルがバラバラだと、検索キーワードを複数回指定しなければならない場合があり、非常に面倒です。また、検索漏れが起こる場合も考えられ、保守性を下げる要因となりえます。
そのため、下記のように、スタイルを決めておくと良いと思います。

1. 数字・英字は半角
2. 漢字・ひらがな・カタカナは全角
3. 全角スペースは使用しない

コードには判断文(if,for,while,case)が多く含まれています。
この判断文にコメントをつけるだけで処理内容が一目でわかるようになります。

ソースコードの可読性を向上させるのは、コードのスタイルを統一することだけではありません。コードの中に的確でかつ、わかりやすいコメントを記述することも可読性の向上に大きくつながります。

変数名のみでもある程度の情報を得やすくするために一般的なネーミング規約の一つであるハンガリアン記法と記憶子を組み合わせて変数名を命名します。
ハンガリアン記法とは、変数の名前に型などの情報を縮めて付加する方法のことです。

インデントがバラバラだと、読み難いコードになってしまいます。
読み難いコードはバグの元です。
そのため、インデントはハードタブで4文字と規定しています。

if文やfor文でネストが深くなると、処理が複雑で、解読が非常に困難になってしまいます。そのため、ネストレベルを5階層までと規定しています。

例）
if(a == 0)                      //ネストなし
{
    if(b == 1)                  //ネスト1
    {
        if(c == 2)              //ネスト2
        {
            if(d == 3)          //ネスト3
            {
                if(e == 4)      //ネスト4
                {
                    a = 1;      //ネスト5
                }
            }
        }
    }
}

とは言っても、処理が複雑になったり、判断条件が増えると、ネストレベルは深くなってしまいます。その対策として、次の方法が考えられます。

• returnで返す

  判定文の後に処理をする必要が無い場合には、returnで返すことにより、ネストが深くなることを防ぐことが出来ます。

  例）
  if(a != 0)
  {
  return;
  }

• 関数化する

  一定のまとまりのある処理を関数化して、その関数を呼ぶことでも、ネストが深くなることを防ぐことが出来ます。

定数に小文字を使うと、変数なのか、定数なのか、見ただけではわかりません。一目で定数とわかるように、定数の場合は小文字を禁止し、大文字を使うように規定しています。

例）
#define MAX_COUNTER     10              →OK
#define Max_Counter     10              →NG（小文字は使用禁止）