コード規約


※上記の広告は60日以上更新のないWIKIに表示されています。更新することで広告が下部へ移動します。

◇命名規則

◆共通事項

1.英単語の省略禁止。
省略可能リストの英単語以外省略禁止。

2.英単語の区切り。
変数名・関数名の英単語の区切りごとに、
先頭のアルファベットを大文字にする。

3.役割の明示。
名前を見ただけで役割を判断できるよう命名する。

4.名前の競合。
競合が発生するおそれのあるような単純な名前をつけない。
Eclipse等クラスを判断して変数を検索できるIDEが共有できる場合は、
この限りでない。

5.ローマ字の禁止。
ローマ字で命名しない。ただし、適当な英訳がない場合、
ローマ字が英単語になっている場合をのぞく。



◆型名

1.基本型
short、float等を使わずライブラリが用意した、s16、f32等を使用する。
ただし、typedef等で変更できない、Java・C#はこの限りでない。

2.構造体・クラス(未完成)
プリフィックスとして、構造体名にはstc、クラス名にはCをつける。



◆変数名

1.変数名の基本形
基本形は、「[スコープ]-[ポインタ]-[プリフィックス]-変数名」とする。

2.スコープ識別
グローバル変数をg_、広域変数をs_、メンバ変数をm_、ローカル変数を無名、もしくはl_とする。

3.ローカル変数
引数と名前が競合しそうな場合等、スコープをつけ、
小文字から開始し、区切りごとに大文字にする。
ポインタの場合、ポインタを表すpの後を大文字とする。

4.ポインタ
型名の前にpをつける。ポインタのポインタの場合はppとなる。
Javaの場合、インスタンスを直接生成していない参照変数には
ポインタとして扱い、型名の前にpをつける。

5.配列
配列の場合、スコープの後にaをつけることを許可する。

6.プリフィックス
C、C++の場合、型名をつける。
bool型の場合のみ、bとする。

Javaの場合、は以下の通り。
型名 プリフィックス
short、int n
long l
char c
byte byte
float f
double d
boolean b
String sz
ハンドル(ハンドルの意味合いを示すもの全て) h

7.ループカウンタ
do、while、for文用にループカウンタを使用することを許可する。
i,j,k,l,m,nまで。



◆関数名

1.基本形
基本形は、「[スコープ]-[動詞]-[目的語]」とする。

2.スコープ識別
グローバル関数をg、広域関数をs、メンバ関数をm、もしくは無名とする。

3.大文字開始
オーバーライド、強調したい関数の場合先頭を大文字にすることを許可する。



◆定数名

全て大文字にする。単語の区切りごとにアンダーバーをつける。
対象は以下の通り。

  • define
  • const
  • enum
  • final static(finalのみの場合は対象にならない)



◆コメント

1.フォーマット
フォーマットは、javadoc形式を使用する。
また、関数に対するコメントの場合は、以下のものを必須とする。

  • @param(引数がある場合のみ引数の説明)
  • @return(返却値の説明)



初版-2009.04.24
第2版-2009.04.24 初樹 変数名プリフィックスの追加、ポインタの説明にJavaを追加
第3版-2010.03.16 初樹 変数名スコープ識別の変更、誤字修正
記入者-初樹(h.atsuki)
ツールボックス

下から選んでください:

新しいページを作成する
ヘルプ / FAQ もご覧ください。