コーディングルールの作成
ソースファイルとヘッダファイルの作成するためのコーディングルールを作成する。
目的：
基本的に自分しか見ないが、数年後見ても自分が分かるようにコーディングルールを決めておく。
出来るだけ、分かりやすいコードを書く。
基本的なコーディングルールを知ることにより、他のプログラムを確認する際に使えるかも？
コーディングルールで決める内容：
命名規則
コーディングスタイル( カッコの方法、コメント方法、インデント方法)
禁止事項（あれば)
制限事項(あれば)
推奨事項（あれば)
ーーーーーーーーーー
ファイル作成規則
.cまたは.cppファイルを作成する場合、必ず同じ名前の.hファイル(ヘッダファイル)を作成する。
ヘッダファイル規則
ヘッダファイルは、必ず下記定義を行う。
code:c
・
・定義
・
//****ファイルの最後(ファイル名.h)＊＊＊＊＊＊＊＊＊
命名規則の基本
名前に英単語と日本語を混在しない。
名前に日本語のローマ字は使わない。
名前はその変数の使用目的を考慮し、わかりやすい名前を付けること
短い変数名はメソッド内のみで使用すること。
日本語 (漢字、ひらがな等) のクラス名や変数名は原則使用しないこと。
変数命名規則
グローバル変数：大文字から始める。
ローカル変数：小文字から始める。
どちらも、途中で大文字/小文字が入るのは有りとする。
定数命名規則
全て大文字で記述する。
→enum、#defineなど
関数命名規則
関数名は基本大文字で始める。
'#define定義規則
'#define定義の定義名は必ず全て大文字で記述する。
定義名にアンダーバー"_"を入れてもよしとする。
プログラム記述規則
数値を直接変数に代入しない。
代入する変数の数値は、 '#define定義したものを使用する。
例外： 0、0.0などの初期値は、そのまま代入しても良いとする。
型定義規則
型定義は、下記規則に則る。 ただし、定義されている特別な型は別とする。
enum型
型名、列挙した名前は必ず全て大文字とする。
列挙した先頭の方には、"=初期値"を必ず入れる。
例：
code:c
enum AAA{
AAA_AA=0 //<AA
,AAA_BB //<BB
,AAA_CC //<CC
};
コメント規則
C/C++のプログラム際のコメント規則は、JAVADOC仕様に準拠する。
守るべきJAVADOC仕様：
ファイル先頭のコメント
ファイルの先頭には、下記コメントを入れる。
code:c
/**
*/
プログラム説明コメント
共通ライブラリとして作成したクラス等には、下記コメントをヘッダファイルに記述する。
code:c
/** \page page1 **** Source Document.
* -# 本プログラムについて<BR>
* -# 依存関係<BR>
* -# 設定<BR>
* -# 使い方<BR>
* -# その他<BR>
*/
関数先頭のコメント
関数の先頭には、必ず下記コメントを記述する。
@paraは、関数パラメータの数だけ記載
関数パラメータがない場合、 @paraは不要
関数に戻り値がない場合、 @returnは不要
code:c
/**
*/
定数や変数のコメント
'#define定義、enum型定義、グローバル変数定義などの右にコメントする場合は、以下のようにコメントする。
code:c
///<説明
/** */
行をまたぐ場合は上記の位置合わせをして記載する。
手前にコメントを記載する場合は以下のようにする。
///説明
/** */
その他のコメン
関数内のプログラム動作コメントについては、右に書く場合も、手前に書く場合も以下のようにコメントする。
code:c
///説明
/** */
修正項目とコメントアウト
バージョンアップ、修正事項は以下のコメントで囲む。
このコメントアウトは、 "//"で行う。
code:c
//--- End Modify
カウント用変数の規則
For や While ループでのインデックス(カウンタ)として使う変数は、i, j, k を使う。
一番外側のループから順に i, j, k を使用すること。
制限事項
1 ラインの文字数：120 文字で折り返す。
１ライン 120以下で折り返しは可能、 120文字以上の記述はしないようにする。