命名規約 - project5j

命名規約

　１．英語と日本語
　　全ての識別子の名前は英語を用いること。

　２．名前空間
　　企業略式名.組織略式名.テクノロジー名.機能名を使用する。また、テクノロジー名にはソリューションが、機能名にはプロジェクトが対応していること。
　　　using Project5j.Bomberman...

　３．クラス名
　　単語ごとに先頭大文字。
　　　例：class PascalCasing

　４．例外クラス名
　　最後をExceptionとしたクラス名。
　　　例：class ClassNameEndsWithException

　５．インターフェイス名
　　クラス名に同じ。また常に最初にIを付ける。
　　　例：interface INameOfInterface
　　また、クラスにある能力を加える様な利用の場合、その能力を示す形容詞とし、-ableを接尾にする。
　　　例: IEnumerable, ICloneable, IXmlSerializable, …

　６．抽象クラス名
　　抽象クラス名に適当な名前が無いとき、 Abstract から始まりサブクラス名を連想させる名前を付ける。
　　　例：abstract class AbstractBeforeSubClassName

　７．非パブリックメンバ
　　先頭に"_"を付加する。
　　単語の先頭は小文字。それ以降、単語ごとに先頭大文字
　　　例：private object _objectName;

　８．パブリックメンバ
　　単語ごとに先頭大文字。
　　　例：public object ObjectName;

　９．定数(const)
　　大文字もしくは大文字を"_"でつないだもの。
　　　例：const int UPPERCASE = 0;
　　　　　const int UPPERCASE_WITH_UNDERSCORES = 0;

　１０．列挙型(enum)
　　単語ごとに先頭大文字。
　　　例：enum PascalCasing

　１１．列挙値
　　単語ごとに先頭大文字。
　　　例：PascalCasing

　１２．イベント名
　　単語ごとに先頭大文字。
　　　例：event PascalCasingEvent()

　１３．デリゲート名
　　単語ごとに先頭大文字。変数名の末尾にHandlerを付加する。
　　どのような場合に呼び出されるか変数名を見てわかる名前をつけること。
　　　悪い例：public delegate void StateHandler();
　　　　　　　public delegate void TimeOutHandler();

　　　良い例：public delegate void StateChangedHandler();
　　　　　　　public delegate void ThreadTimeOutHandler();

　１４．メソッド名
　　単語ごとに先頭大文字。
　　　例：void PascalCasing();
　　　　　object PascalCasing();

　１５．ファクトリメソッド(オブジェクトをnewするもの)
　　createの後に先頭が小文字で始まるオブジェクト名を付加する。
　　　例：ObjectName createObjectName();

　１６．コンバータメソッド(オブジェクトを別のオブジェクトに変換するもの)
　　to, fromの後に先頭が小文字で始まるオブジェクト名を付加する。
　　　例：void toObjectName();
　　　　　ObjectName fromObjectName(object obj1);

　１７．プロパティ名
　　単語ごとに先頭大文字。
　　　例：object PascalCasing {
　　　　　}

　１８．Boolean変数を返すメソッド
　　Is + 形容詞、Can + 動詞、Has + 過去分詞、三単元動詞、三単元動詞 + 名詞。
　　　良い例：bool IsEmpty()
　　　　　　　bool CanGet()
　　　　　　　bool HasChanged()
　　　　　　　bool Contains(object x)
　　　　　　　bool ContainsKey(string key)

　　　悪い例：bool Empty() //「空にする」という動詞的な意味に取れる。
　　　　　　　bool CheckXXX() // trueがどちらの意味か分かりづらい。
　　　理由　：if, while文等の条件が読みやすくなる。
　　　　　　　またtrueがどちらの意味か分かりやすい。

　１９．bool変数
　　形容詞、is + 形容詞、can + 動詞、has + 過去分詞、三単元動詞、三単元動詞 + 名詞。
　　　例：bool _isEmpty;
　　　　　bool _dirty;
　　　　　bool _containsMoreElements;

　２０．名前の対称性
　　クラス名、メソッド名を付ける際は、以下の英語の対称性に気を付ける。
　　　Add / Remove
　　　Insert / Delete
　　　Get / Set
　　　Start / Stop
　　　Begin / End
　　　Send / Receive
　　　First / Last
　　　Push / Pop
　　　Up / Down
　　　Upper / Bottom
　　　Show / Hide
　　　Source / Target
　　　Open / Close
　　　Source / Destination
　　　Increment / Decrement
　　　Lock / Unlock
　　　Old / New
　　　Next / Previous

　２１．ループカウンタ
　　スコープ（通用範囲）が狭いループカウンタには i, j, k という名前をこの順に使う。

　２２．スコープが狭い名前
　　スコープが狭い変数名は，型名を略したものを使って良い。
　　　例： DataSet ds = new DataSet();

　２３．意味がとれる名前
　　変数名から役割が読み取れる名前をできる限り指定すること。
　　　悪い例：Copy(string s1, string s2)

　　　良い例：Copy(string source, string destination)