KUSAMAKURA

智に働けば角が立つ。情に棹させば流される。意地を通せば窮屈だ。とかくに人の世は住みにくい。

boolean 値を返却するメソッド名、変数名の付け方

boolean 値を返却するメソッド名や、変数名の名前のテンプレを作ってみた。名前に気を付けるだけで、意外と綺麗なコードになるので、参考にして欲しいです。

名前の付け方


  • is + 形容詞
    形容詞の状態であるかを尋ねる.
    ex) isEnabled

  • has + 過去分詞
    動詞の状態となったか(完了、経験、継続)を尋ねる.
    ex) hasSent

  • can + 動詞原型
    動詞の挙動が可能かを尋ねる.
    ex) canGet

  • 三単現動詞
    動詞の状態かを尋ねる.後に続く名詞が明確な場合に利用する.
    ex) exists

  • 三単現動詞 + 名詞
    動詞の状態に名詞があるかを尋ねる.
    ex) existsError, hasError

  • should + 動詞原型
    動詞の挙動を行うべきか尋ねる.
    ex) shouldCollect, shouldRedirect

NOTE:
※基本的に Yes を動詞, 形容詞とする.
is beautiful? Yes, beautiful!!

アンチパターン


  • check + Something
    Yes,No が不明確.
    ex) checkError, checkValid

  • is + be
    文法的に誤り.
    ex)
    誤:isFail, isEnable
    正:isFailed, isEnabled

  • 動詞原形 + 名詞 文法的に誤り.
    ex)
    誤:existError
    正:existsError