Java命名規則

命名規則一般

• 基本は正しくフルスペルの英語を用いる。
• 英語と日本語の対応訳語集を作成する。
• あまりに長い文字は避ける。15文字以内。
• やむえず略語を用いる場合は、略用語集を作成する。
• ControlはCtrlとする、等。

クラス名

一般クラス名

原則

• 大文字で始まる名詞。
• 複数の単語で構成される場合，2つ目以降の単語は大文字で始める。
• 具体的でシンプルで記述しやすいものにする。

インターフェース名

原則

• クラス名と同様。
• 先頭にIをつける。

抽象クラス名

原則

• クラス名と同様。
• 先頭にAbstractをつける。
• Templeteパターン、などを使わない限り、あまり積極的に使用せず、インターフェースにする。

フィールド名

原則

• 小文字で始まる名詞、もしくは形容詞。
• そのフィールドが表現していることが明確になるようにする。
• 配列やベクタのような集合を表わすフィールドには、複数形の名前を与える。
• （例） Vector orderItems;
• 同じ単語の単数形と複数形を同時に違う意味で使用しない。
• 頭や末尾に記号をつけるなど、ハンガリアン記法は用いない。（検討中）
• フィールド名は先頭にm_をつけること。

定数

• 全て大文字で、_で文字をつなぐ。
• static finalとする。

メソッド名

原則

• 小文字で始まる能動態の動詞。
• 複数の単語で構成される場合，2つ目以降の単語は大文字で始める。
• そのオブジェクトに対してどうするのかが一目でわかるようにつける。
• あまり抽象的な名前は、いくつかの処理を同時に行っている可能性がある。メソッドの分割を考える。
• 同じ名前の単数形と複数形を同時に違う意味で使用しない。
• 引数なしのデフォルトコンストラクタを必ず作る。

用法による命名規則

• フィールドに対する読み出しメソッドは、setXXXとする。
• ただしbooleanを返すものは、isXXXとする。場合よってはhasXXXも可。一般動詞は不可。
• フィールドに対する設定メソッドは、getXXXとする。
• フィールドに対応しない、読み出し・設定メソッドには、set、getは使わない。
• オブジェクトを生成するファクトリメソッドは、newXXX()とする。
• Singletonのインスタンスを取得するものは、getInstance()とする。

ローカル変数名

原則

• フィールド名と同様の規則。
• メソッド引数は、先頭にaかanをつける。（検討中）
• 無意味な名前、buf、tmp、str、data等は使用しない。
• 場合によって、用法による命名規則を用いる。

用法による命名規則

• ストリーム
• InputStream、OutputStreamは、in、outにする。
• Reader、Writerは、XXXXreader、XXXXwriterとする。
• 例外オブジェクト
• catch節で引数とする例外オブジェクトは、exとする。
• イベントオブジェクト
• Eventオブジェクトは、XXXEventとする。（例：keyEvent）
• ループカウンタ
• forループ等のループカウンタには、i,j,kの順番で用いてもよい。
• 1重ループの場合は、loopCounterとするのがよい。