以下は JE2BWM ほかが作成した翻訳です。原文は University of California より GFDL で配付されており、この翻訳も GFDL に従います。
原文: BOINC coding style (翻訳対象の更新日付は 5:24 PM UTC, October 05 2005 です)。

BOINC コーディング・スタイル

言語共通のスタイル

ソースコードの整理

ソースコードに繰り返しがあれば、共通部分を取り出して関数にします。
1つの関数の大きさが 100行程度を越えたら、分割して下さい。
もし、ファイルが埋め立て地のゴミ置き場のようになってしまったら、分割します。
C++ の .h には、しばしばインタフェースと実装が混在します。はっきりと分けて下さい。

ソースコードの文書化

.C ファイルの先頭に、そのファイルに入っている内容を示すコメントを付けます。（そして多分、何が含まれていないかも書きます)。
関数の前に、それが何をするものなのかのコメントを付けます。
構造体(struct)とクラスの前にも、それが何者なのかを示すコメントを付けます。

名前付け

名前は、長くなりすぎない範囲で、内容を描写するものであるべきです。 (ローカル変数は短い名前であって構いません)
Class 名と型名、そして #define で定義したシンボルは、全て大文字で名前をつけ、名前の中に単語を[複数] 含むときはアンダースコアで区切ります。
変数と関数の名前には小文字を使い、名前の中に単語を[複数] 含むときはアンダースコアで区切ります。
大文字と小文字を一つの名前に混ぜて使ってはいけません。

字下げ(インデンテーション）

字下げの幅はどこでも 4つの空白です（タブは使いません)。

複数行を使って書く関数呼出しは、以下のようにします。

        func(
            blah, blah, blah, blah, blah,
            blah, blah, blah, blah, blah
        );

switch 文: case ラベルは、キーワードの switch と同じレベルに字下げします。

        switch (foo) {
        case 1:
            ...
            break;
        case 2:
            ...
            break;
        }

定数

ソースコードの中で直接に数値を書くことは、ほとんどの場合避けます。数値を使うときは、直接それをソースの中に書く代わりに #define で定義して使うべきです。

中括弧（ブレイス）

中括弧の開きは、行末に置きます（次の行にはもっていきません)。つまり、以下のようにします。

        if (foobar) {
            ...
        } else if (blah) {
            ...
        } else {
            ...
        }

複数行に渡る if 文では、必ず中括弧を使います。

        if (foo)
            return blah;        // 違反の例

1行の if 文では、中括弧なしを許します。つまり、下記はＯＫです。
```
        if (foo) return blah;
    
```

コメントと #ifdef

すべてのコメントの印には、 // を使います。
ひとかたまりのソースコードをコメントアウトするときは、以下のようにします。
```
        #if 0
            ...
        #endif
    
```

C++ 固有のスタイル

#include

一つの .C ファイルは、そのファイルをコンパイルするのに必要な最低限の #include 行を、 [直接に] 含まねばなりません。 (たとえば、foo.C が必要とする #include 行は foo.C に含まれるべきであって、 foo.h に含めるべきではありません)
#include 行は、一般的なものから (<stdio.h>) 固有なもの(thisfile.h) の順に並べます。

extern 宣言

foo.h には、foo.C が含んでいるすべての public な関数と変数を 'extern' で宣言するべきです。 .C ファイルには、'extern' 宣言文を置くべきではありません。

static 宣言の使用

もし、関数または変数が、ただ1つのファイルでのみ使われているなら、それらを static と宣言します。

やむを得ない場合を除き、避けるべきもの

インライン関数
演算子と関数のオーバローディング
テンプレート

避けるべきもの

型の定義には、 typedef ( #define ではなくて) を使ってください。
Ｃ言語と互換性がないクラスを初期化したり複写する場合に、 memset() や memcpy() を使ってはいけません。必ず、デフォルト・コンストラクタと複製のためのコンストラクタを書いてください。

エラーコード

(ほとんど) すべての関数は、整数値のエラーコードを返すべきです。ゼロでない値がエラーを意味します。エラーコードのについては、lib/errornumbers.h を見てください。
エラーコードを返す関数を呼ぶときは、その返却値を検査するべきです。一般的に言って、呼び出してエラーを見つけたら、リターンするべきです。たとえば、以下のように。
```
            retval = blah();
            if (retval) return retval;
    
```

構造体(struct)の定義


    struct FOO {
        ...
    };

    FOO x;

PHP 固有のスタイル

POST および GET 要求のデータの獲得

侵入を企てる輩は、POST および GET 要求に、恣意的な値のデータを渡してくることがあり得るということを、よく憶えておいてください。そしてそれを使って、 SQL インジェクションなど、ソフトウエアの弱点につけ込もうとします。

変数 $_POST と $_GET から直接データを取り出して使ってはいけません。
POST および GET のデータを取り出すには、(util.inc の中にある) get_int()、 get_str()、 post_int()、 post_str() という関数を使ってください。
POST および GET で渡される値を、 SQL クエリーの中で使う場合には、 process_user_text() 関数を使って、 [意図しない機能を呼び出すかもしれない部分を無効にするよう]、そのデータをイスケイプして下さい。

BOINCの訳のメインページに戻る | (原文のメインページに戻る)

最終更新時刻 00:47:27, 2006年08月12日(JST)
Copyright © 2008 University of California. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.
Copyright © 2008 Komori Hitoshi(je2bwm at jarl.com). Japanese translation from English web pages on BOINC. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation.