株式会社アルウィン C 言語コーディング規約 ver.0.1

Size: px

Start display at page:

Download "株式会社アルウィン C 言語コーディング規約 ver.0.1"

しまなはにうだ
4 years ago
Views:

1 C 言語コーディング規約 ver.0.1

2 1. はじめに本コーディング規約は ( 株 ) アルウィン社内で作成する C 言語ソースコードの可読性メンテナンス性の向上丌具合の混入を防ぎやすくするための記述方法及び推奨する記述方法を記述した文書である 2. 目的本コーディング規約はソースコードの可読性メンテナンス性の向上丌具合の混入を可能な限り防ぎ品質の高いソースコードを作成する一助とすることを目的とする 3. 適用範囲本コーディング規約は ( 株 ) アルウィン社内で作成する全ての C 言語ソースコードに適用されるただし納入先のコーディング規約に従う場合やプロジェクトで独自に規約を定めている場合はその限りではない page 1

3 4. 命名規則共通原則として単語を省略せずに意味の分かる命名とすること Info Data Temp Str Buf 等の無意味な名前は再検討すること関数基本先頭は原則として動詞とし動詞部分を全て小文字以降の単語は区切り文字を大文字とすること例 ArrayList* getarraylist(void) 動詞の対称性関数名に付ける動詞は以下の英語の対称性に気を付けること add/remove insert/delete get/set get/release put/get start/stop begin/end send/receive first/last up/down show/hide source/target source/destination open/close increment/decrement lock/unlock old/new next/previous 真偽を返す関数 is+ 形容詞 can+ 動詞 has+ 過去分詞三単元動詞三単元動詞 + 名詞とすること例 int isempty(void) int canget(void) int haschanged(void) int constains(void) int constainskey(void) 仮引数の意味の対称性対称性のある仮引数は対称性のある名称とすること例 int copy(char* source, char* destination) page 2

4 変数名ローカル変数全て小文字で記述し単語の区切りはアンダースコア "_" を入れること例 local_value グローバル変数先頭に "g_" を付けて全て小文字で記述し単語の区切りはアンダースコア "_" を入れること例 g_global_value 定数全て大文字で記述し単語の区切りはアンダースコア "_" を入れること例 const int CONST_VALUE = 300 ループカウンタ 20 行程度で終わるループの場合ループカウンタの名称を i,j,k など意味の無い変数名としても良い列挙型タグ先頭に "tag" を付けて単語の区切りは大文字とすること列挙定数区切り文字を大文字で記述すること別名区切り文字を大文字で記述することタグ名の "tag" を削除した残りと一致させること例 enum tagorder FIRST=0, SECOND, THIRD }Order; page 3

5 構造体共用体のタグタグ先頭に "tag" を付けて単語の区切りは大文字とすることメンバ区切り文字を大文字で記述すること別名区切り文字を大文字で記述することタグ名の "tag" を削除した残りと一致させること例 typedef struct tagstruct int member1; int member2; }Struct; ディレクティブディレクティブで使用する名称は全て大文字で記述し単語の区切りはアンダースコア "_" を入れること例 #define CONST_VALUE (300) #if CONDITION_A #endif #define MAX(a,b) (a>b?a:b) page 4

6 5. コメントコメントのスタイル doxygen で認識されるコメントのスタイルを推奨するファイルヘッダファイルヘッダは必ず付けること関数ヘッダ外部へ公開するヘッダファイルには必ず関数ヘッダを付けること変数宣言時に意味を記述すること構造体共用体のメンバ列挙定数定義時に意味を記述すること無意味なコメントの禁止無意味なコメントは記述しない例 a = b; // b を a に代入する TODO コメント短期的なその場しのぎの解決であったり十分ではあるけど完璧でないコードは TODO コメントを記述すること page 5

7 6. ヘッダファイルインクルードガードヘッダファイルには必ずインクルードガードを記述することインクルードガードの終わりにはガード時の名称のコメントを記述することインクルード必要十分なインクルードをすること 7. プリプロセッサ命令基本リテラルを置き換えるための #define インクルードガード以外のプリプロセッサ命令はできる限り使用しないこと処理の切り分けプリプロセッサ命令で関数内の処理を切り分ける場合ブロックを跨がないこと悪い例 #if CONDITION_A a = b; #else a = c; #endif } 処理の置き換えの禁止 #define を使用して処理を記述しないことインデントの禁止プリプロセッサ命令はインデントせずに行のはじめから記述すること page 6

8 8. 関数プロトタイプ宣言ファイル内でのみ使用する関数であっても必ずプロトタイプ宣言をすること関数の分け方複数の機能を持った関数を定義せず 1 つの機能で 1 つの関数を作成すること関数の行数できる限り 100 行以内でおさめること仮引数仮引数の変更は行わないこと戻り値戻り値を括弧で括らないことローカル変数の初期化ポインタ変数は必ず初期値と共に宣言することその他の変数はできる限り初期値と共に宣言すること 9. 再帰関数基本できる限り再帰関数は使用しないことスタック使用する場合再帰関数内のローカル変数の宣言は極力少なくすること終了確実に再帰が終了するように設計すること page 7

9 10. 構造体定義 typedef 指定子を用いて別名を定義し再利用しやすくすることタグ名タグ名を必ず付けること例 typedef struct tagstruct int member1; int member2; }Struct; Struct value; 11. 列挙型定義 typedef 指定子を用いて別名を定義し再利用しやすくすることタグ名タグ名を必ず付けること例 enum tagorder FIRST=0, SECOND, THIRD }Order; page 8

10 12. コーディングスタイルインデントスペースのみを使用すること毎回スペース2つずつインデントを入れることブロック単位でインデントを入れること長い行一行の最大は 120 文字とし超える場合は行を分割すること const static できる限り const を使用することファイル内のみで使用するグローバル変数には static を使用すること制御文括弧内の記述括弧の内側にはスペースを入れないことブロック省略の禁止ブロックを省略しないこと悪い例 for(i = 0; i < MAX; ++i) a += i; ブロックの記述位置制御文のキーワードと同じインデント位置にブロックを記述することブロック内はインデントを入れること例 for(i = 0; i < MAX; ++i) a += i; } for 文セミコロンの後にスペースを一ついれること page 9

11 switch 文原則として case 節は break 文で終わらせること空の case 節を使用する際には case 節の中にコメントを記述しないこと常に default ケースを持つようにすること while 文 do while 文できる限り for 文を使用すること while 文 do while 文を使用しなければならない場合確実にループ外に抜け出せるようにすること goto 文できる限り goto 文を使用しないこと page 10

Microsoft PowerPoint - CproNt02.ppt [互換モード]

Microsoft PowerPoint - CproNt02.ppt [互換モード] 第 2 章 C プログラムの書き方 CPro:02-01 概要 C プログラムの構成要素は関数 ( プログラム = 関数の集まり ) 関数は, ヘッダと本体からなる使用する関数は, プログラムの先頭 ( 厳密には, 使用場所より前 ) で型宣言 ( プロトタイプ宣言 ) する関数は仮引数を用いることができる ( なくてもよい ) 関数には戻り値がある ( なくてもよい void 型 ) コメント