コーディングスタイル

ヘッダの書き方

「詳細設計書を書かずにコーディングする。詳細設計書を更新しない。」ということは、よくある。そこで、ヘッダを詳細設計書として機能させるとよいであろう。その場合、記述方法が統一されているべきであろう。以下にサンプルを示す。

/*-------------------------------------------*/
//
//  日本語クラス名
//    グラフクラス
//
//  概要
//    任意のノードやアークのグラフ構造用のコンテナ
//
//  機能説明
//    ノードやアークのの追加、削除、走査
//
//  備考
//    なし
//
/*-------------------------------------------*/

1行は、なるべく半角80文字以内。

コーディングスタイル

以下に述べるものは、私のコーディングスタイルである。基本は、「短くわかり易く」である。「このコーディングスタイルが優れている」という訳ではなく、コーディングスタイルを統一するために明文化している。何故なら、「スタイルを統一しないのは、どんな悪いスタイルを使うことより悪い」と言えるからだ。特にチームで開発する場合は、独自のスタイルを用いるのはやめて、チーム内で統一しているスタイルになるよう心がけるようにしよう。

関数や変数の名前の付け方については、以下でも述べるが、別途聞いてもらった方がいいかもしれない。

むやみに空行はいれない。
関数名は「動詞+名詞」の形で、変数名はなるべく短くする。
関数名は大文字で始め、変数は小文字で始める。区切りはアンダースコアではなく、大文字にする。
× read_file(); ^^ ^^ ○ ReadFile();
例外として、
- m_xxx はメンバ変数を意味する。
- s_xxx は静的メンバ変数を意味する。
- g_xxx は大域変数を意味する。
これらは、習慣的なものである。
クラス名は、大文字のC で始め、次の文字も大文字にする。
class CStatBase {
マクロは全て大文字にする。
++i, i++のどちらでもよいときは、++iと書く。
i が反復子のときは効率が良いことがある。
C++でC用のヘッダを読込む時は、なるべく「<cXXX>」を使う。 include の後は空白を置く。
× #include<cmath> ^^ ○ #include <cmath>

「｛」は非インライン関数の始まりを除いて行の終わり。「} else 等」は同じ行に書く。

    class A {
    public:
        void func()const{cout << "ok\n";}
    };

        if (i == 0) {
            i = 1;
        } else if (j == 1) {
            j = 1;
        }
        for (i=0;i<n;++i) {
            // ...
        }

インデントの幅はタブ１つで４文字分にする。
for (i=0;i<n;++i) { if (isalpha(buf[i])) { putchar(buf[i]); } else { putchar('.'); } }
通常、タブ１つは 8 文字だが、エディタで設定できることが多い。但し、emacs を使っている人は、4 ではなく 8 で設定して欲しい。（4 にすると、空白4文字に変換してしまうので。）

予約語if、for、while、switch 等の後ろに必要な「(」の前には空白を置く。「)」の後に「{」を書く場合には、間に空白を置く。

        ×  if(i == 0) { .. /* if の直後の空白がない */
             ^^
        ×  if (i == 0){ .. /* { の直前の空白がない */
                        ^^
        ○  if (i == 0) { ..

関数等の後ろに続く「(」の前には空白を置かない。

        ×  printf ("Hello world!\n");
                 ^^^
        ○  printf("Hello world!\n");

「(」と、そのの直後の文字との間には、空白を置かない。「)」とその直前の文字との間にも空白を置かない。
× if ( c == EOF ) { .. ^ ^ ○ if (c == EOF) { ..

セミコロン（;）の後に続ける場合は、空白を置く。カンマ（,）の後には置かない。

        ×  printf("i = %d\n", i);
                              ^^
        ○  printf("i = %d\n",i);

例外：初期化する場合は、1文字空ける。

        ○  int     i,j,k, n = 10;
                          ^^

単項演算子とそれを作用させる式などの間には空白をあけない。
× i ++; ^ ○ i++;
２項演算子の両側には、原則として空白を１つずつ置く。ただし、特に理由のある場合にはその限りではない。
× sum=a+b; ^^^^^ ○ sum = a + b;
例外：for 文では、1文字空けない。 for は 1まとまりで認識するので、詰まっている方がわかりやすい。
○ for (i=0;i<n;++i)
構造体のメンバをアクセスするためのピリオド（.）や -> の両側には空白を置かない。
× cursor . x = p -> h; ^ ^ ^ ^ ○ cursor.x = p->h;

３項演算子 ?: の、「?」、「:」の両側には、原則として空白をおく。

        ×  abs = (a < 0)?-a:a;
                        ^^^^^
        ○  abs = (a < 0) ? -a : a;

キャスト演算子は、dynamic_cast, static_cast, const_cast, reinterpret_cast を用い空白は使用しない。

        ×  i = static_cast<int> (c);
                                ^^
        ○  i = static_cast<int>(c);

return の後に不必要な () は付けない。

        ×  return (0);
                   ^ ^
        ○  return 0;

switch 文の書き方（'{' '}' の位置）

    switch (XXX) {
    case XXX:
        ..
        break;
    // ...
    }

if 文の書き方（'{' '}' の位置）

    if (XXX) {
        // ...
    } else if {
        // ...
    } else {
        // ...
    }

関数の定義の例。（'{' '}' の位置）

    unsigned int foo()
    {
        // ...
    }

変数宣言の次に、空白行を入れない。

配列の [] の前後には空白をあけない。

    ×  array [10]
             ^
    ○  array[10]

式文を表す ; の直前には空白をあけない。

    ×  char keyword[10] ;
                        ^
    ○  char keyword[10];

変数の宣言の仕方の例。
FILE* fp; double& x = y; int i,j;
* や & は型名のすぐ後に書き、なるべく変数部分を揃える。

戻る