命名規則についての覚書

いつも忘れてしまうので備忘録的に残しておきます。

• 参考とさせていただいたページ

ファクトリメソッド

メソッド内でオブジェクトをnewして、インスタンスを戻り値として返すようなもの。
この命名規則には2種類ある。

• 引数がない場合
  • 先頭にnewをつける
• 引数がある場合
  • 先頭にcreateをつける

// 例1. 引数がない場合
function newDevice() {}

// 例2. 引数がある場合
createDeviceChecker($userAgent)

コンバータメソッド - 何か変換するようなメソッド

オブジェクトを別のオブジェクトに変換するときのメソッドです。
この場合、対象のオブジェクトの先頭にtoをつける。

toStringData()

booleanを返すメソッド

boolean(true|false)をを返すメソッドについては下記5通りで命名します。

• 「is + 形容詞」
• 「can + 動詞」
• 「has + 過去分詞」
• 「三単現（三人称単数現在）動詞」
• 「三単現動詞 + 名詞」

// is+形容詞
isEnabled()
isIos()
isAndroid()
isWeb()

// can+動詞
canGet()
canRemove()
canDelete()

// has+過去分詞
hasCanged()
hasExcluded()
hasIncluded()

// 三単現動詞
contains()

// 三単現動詞+名詞
containsKey()