目的
プロジェクトの構成
禁止事項
制限事項
推奨事項
コーディングスタイル
- コメントがなくても読めるプログラムを書く
- コードの読みやすさを優先する
- 見れば分かるコメントは書かない
- 分かり易さを優先する
- 変数のスコープは必要以上に大きくしない
- ソースコードは「AS IS（現在の姿）」であるべき。
過去の履歴は不要。履歴を残す場合は外部ファイル(.md)に残す - ヘッダコメントを付ける
- データ側、引数の渡し方は明示的に宣言する
- 戻り値を使用しないプロシージャの呼び出しはCallで行う
- プロシージャは長くなりすぎないようにする
- ステートメントは長くなりすぎないようにする
ヘッダコメント
------------------------------------------------------ @ description : 役割 @ auther : 作成者（イニシャル程度でよい） @ version : バージョン @ since : 作成日 @ update : 最終更新日 ------------------------------------------------------
関数コメント
------------------------------------------------------ @ brief : 要約 @ param : 引数 @ return : 戻り値 @ detail : コメント ------------------------------------------------------
命名規約
変数、定数、関数名、クラス名etc
全体
- 慣例となっているものについてはその例に従う。自己流を避ける。
変数・定数
- 変数・定数は必ず宣言する。強制させる仕組みがある場合は利用する。
宣言のコメントに正式名称を記載する。 - 基本ローワーキャメルケース。但し言語で推奨されているものがある場合は従う
- 短くて済むなら省略しない。10文字以内。
- 省略すると別の意味となるものは省略しない。
- 変数の文字数は20字以内
- 変数名に動詞は使わない
- 真偽値（Boolean型(true or false)）を格納する変数名は「isXXX」
- 変数宣言エリアを作る（variable declaration）
- 定数は大文字
関数・クラス
- 関数名は動詞＋目的語にする
EOF