😽

GitHub の kettanaito/naming-cheatsheet がよい

1 min read

(書き途中です)

https://github.com/kettanaito/naming-cheatsheet という命名規則についてまとめたGitHubのREADMEがある。割と自分の趣味にもあって名前を付けるときの参考にしている。

Naming functionsのA/HC/LC Patternとかめちゃくちゃいい。

Naming functions

A/HC/LC Pattern

関数を命名するときに次のような便利なパターンがあります。(?は省略可):
前置詞? + 動作(A) + 高文脈 (HC) + 低文脈? (LC)
  • getPost (動作+高文脈)
  • getPostData (動作+高文脈+低文脈)
  • handleClickOutside (動作+高文脈+低文脈)
  • shouldDisplayMessage (前置詞+動作+高文脈)

注意:コンテキストの順序は変数の意味に影響します。例えば、shouldUpdateComponentは、コンポーネントを更新しようとしていることを意味し、一方、shouldComponentUpdateは、コンポーネントがそれ自身で更新されることを伝え、あなたはそれがいつ更新されるかを制御しています。言い換えれば、高いコンテキストは変数の意味を強調します。

Actions

Context

Prefixes

変数名の意味を強化するのによく使われる。関数名にはあまり使われない。(MEMO: C#のプロパティのような実装は関数だけど外からみると変数のようなものには使ってよいと思っている)

  • is ... 現在文脈の特徴や状態(基本はbool) isBlue, isPresent
  • has ... 現在文脈で特定の値や状態を持っているか(基本はbool) hasProducts
  • should
  • min/max
  • prev/next

Singular and Plurals