mem-on

命名規則

Boolean 型の関数や変数を命名する際に利用する具体的な命名規則を紹介します。

be 動詞 + 形容詞

今その状態にあるかどうか ? を表す場合には以下の be 動詞 + 形容詞 形式で名前を付ける場合があります。ただし該当する状態を表す動詞が存在する場合には次の (動詞の三人称単数現在形) を利用します。 Be 動詞の人称は三人称単数を利用する事が一般的です。

// アクティブかどうか
bool isActive(struct object obj);

変数名	意味
`isEmpty`	(主にコレクションなどが) 空かどうか
`isActive`	有効かどうか

中学校の英語の授業で習った『三単現』のことです。動詞の表す状態になっているかどうか ? を返す関数につける名前です。関数の動作を日本語で表現した際に、サ変動詞になる場合はこの命名が適していることが多いです。

// 指定したファイルが存在するかどうか
bool File.Exists(string path)

変数名	意味
`Exists`	(ファイルなどが) 存在するかどうか

動詞の過去分詞形を利用します。関数の動作を日本語で表現した際に、サ変動詞になりかつ受動態の場合にはこの命名が適していることが多いです。受動態であることを明記したい場合には be 動詞 + 動詞の過去分詞形 にする場合もあります。

変数名	意味
`checked`	チェックされた (チェックされている)
`selected`	選択された (選択されている)

動詞の前に助動詞を付ける形式です。 can, should, will, などの助動詞の表すニュアンスを利用したい場合にはこの命名を行います。

変数名	意味
`canPlay`	再生可能かどうか
`willFetch`	(何らかの条件判定の結果)、この後 Fetch を行うかどうか

ある動作・処理が現時点で継続しているかどうかを表現する場合に利用します。

変数名	意味
`running`	実行中かどうか
`downloading`	ダウンロード中かどうか

ある処理が完了しているかどうかを表す場合には has, have + 動詞の過去分詞形を利用します。あるタイミングで、一度行える処理とセットになることが多いです。受動態との混同が無い場合にはhas, have` を省略する場合もあります。

変数名	意味
`hasFinished`	ある処理が完了したかどうか
`done`	ある処理が完了したかどうか