CodingRuleFileFormat - UltraMonkey-L7 Wiki - UltraMonkey-L7

ファイルフォーマット

各ファイルについては，下記のフォーマット（書式）で記述すること．

各ファイル共通

• 改行コードは LF を使用すること
• マルチバイト文字列が含まれるファイルは，文字コードセットとして UTF-8 を使用すること
• 一行の文字数は 80 字以内とすること
• ホワイトスペースは半角スペースを使用すること（全角スペースは使用禁止とする）
• インデントは半角ホワイトスペース 4 個を使用すること
• コメントは // 形式を使用すること
  • 複数行にわたるコメントについても，各行の先頭に // を挿入しコメントとすること
• ファイル冒頭に適用ライセンスに沿ったライセンス条文を挿入すること
  • LGPLv3 原文
  • LGPLv3 日本語訳

ヘッダファイル（*.h）

• 宣言が重複しないよう，マクロを定義すること
  • マクロ名は，下記のルールに従って命名すること
    • プレフィックスにアンダースコアを付加
    • ファイル名をすべて大文字に変換
    • ドットはアンダースコアに変換
    • サフィックスにアンダースコアを付加
  • #endif ディレクティブを記述する行のコメントとして，マクロ名を記述すること．

例： scheduler_rr.h の場合

 #ifndef _SCHEDULER_RR_H_
 #define _SCHEDULER_RR_H_
 ....
 #endif // _SCHEDULER_RR_H_

• ヘッダファイル内で #include を使用しないこと
  • ソースファイル内で，インクルード順序を考慮すること
• クラスを定義するヘッダファイルの場合は，ひとつのファイルにひとつのクラスを記述すること
  • ただし，密接に関連するクラス（特定のクラスに対する例外を処理するクラスなど）は同じファイルに記述することを許容する

ソースファイル（*.c，*.cpp など）

• マジックナンバを使用しないこと
  • 定数を使用する場合は，マクロとして定義すること
• #include によるインクルードは，先頭部分でのみ行うこと
  • インクルードの順序は，下記の順とし，各括りの中ではアルファベット順に記述する
    1. config.h など，プロジェクト独自の定数が定義されているファイル
    2. C 向け標準ヘッダファイル
    3. C++ 向け標準ヘッダファイル
    4. その他外部ライブラリ用ヘッダファイル
    5. プロジェクト固有ヘッダファイル
• NULL 判定を行う場合は，0 ではなく NULL を使用すること
• 配列や構造体のサイズを sizeof キーワードによって取得する場合は，対象の変数ではなく，型を指定すること

   int foo(...)
   {
       struct data_structure data;
       int data_size = 0;
   
       data_size = sizeof (data); // bad
       data_size = sizeof (struct data_structure); // good
       ....
   }

• goto を適切に使用し，コードの重複を避けること

   #define USER_NAME_LENGTH 64
   #define PASSWORD_LENGTH  64
   int foo(...)
   {
       int error_code  = 0;
       char *user_name = NULL;
       char *password  = NULL;
   
       user_name = (char *) malloc(sizeof (char) * USER_NAME_LENGTH);
   
       if (user_name == NULL) {
           error_code = -1;
           goto user_name_initialization_failed;
       }
   
       password = (char *) malloc(sizeof (char) * PASSWORD_LENGTH);
   
       if (password == NULL) {
           error_code = -1;
           goto password_initialization_failed;
       }
   
       // some operation
   
       free(password);
   
   password_initialization_failed:
       free(user_name);
   
   user_name_initialization_failed:
       // nothing to free
       return error_code;
   }

  Pour vous inscrire maintiennent numéro, vous aurez pu votre compte driver (utile à votre portabilité du numéro) numéro rio. Vous obtiendrez pouvez obtenir pour aucun coût par entrer en contact avec la voix expression du serveur ou du service à la clientèle votre propre vieille fournisseur numero rio bouygues . Vous ne mai get un SMS avec vos . Avec votre rio orange, alors vous serez en mesure de vous abonner à l' offre de de son à propos citrons .