mem-on

命名規則

Boolean 型の関数や変数の命名をする際に考慮すべきことを紹介します。

前提

Boolean 型の関数や変数は多くの場合で以下の様な使われ方をします。

Boolean 型の命名を行う際には以下の点を検討する必要があります。

Boolean 型の戻り値を持つ関数のドキュメントでは英語で以下の様な記述がされていることが多いです。

Returns true if xxxx. Otherwise, returns false.

日本語では以下の様に記述されます。

xxxx 場合は、true。それ以外の場合は false。

この様に Boolean 型の関数や変数は、『〇〇であるか、そうでないか』といった表現の通り二値であることが明白な名前が好ましいです。

変数は初期化・代入される回数よりも、多くの回数読み出されることの方が多いです。そのため変数名は読み出される箇所での視認性を考慮してつける必要があります。多くのプログラミング言語では if 文は以下の様に記述されるため、どういった状況の時にどちらの側に分岐するのかが分かりやすい変数名が良いです。

if (condition) {
  //  が true の時に実行されます
} else {
  //  が false の時に実行されます
}