寫給自己看的命名備忘錄

如何給變數取名字

1. 如果要返回一個資料
   • 函式名字是名詞
2. 如果只做事不返回
   • 函式名字是動詞

react 元件內部函式宣告順序

1. static 開頭的類屬性，如 defaultProps、propTypes。
2. 建構函式，constructor。
3. getter/setter
4. 元件生命週期。
5. _ 開頭的私有方法。
6. 事件監聽方法，handle*。
7. render開頭的方法，有時候 render() 方法裡面的內容會分開到不同函式裡面進行，這些函式都以 render 開頭。
8. render() 方法

React 命名思路 -- 參照(copy)自 方方 GuUI - react 命名部分

1. 普通變數只能用名詞

   let user = {...} // right
   let getUser = {...} // wrong
   複製程式碼

   1. 不允許新增 info、data 字尾,

   let userinfo, userData // wrong
   複製程式碼

2. 布林變數只能有下面幾種形式
   1. 形容詞, 如 active
   2. be 動詞接名詞, 如 isAdmin
   3. 動詞的完成時態 (也就是動詞的 ed 形態), 如 created, destroyed, broken
   4. has 接名詞, 如 hasChild
   5. 介詞接名詞, 如 inCache
3. 函式
   1. 無引數函式用不及物動詞, 如 die()
   2. 有引數函式用及物動詞, 如 remove()
   3. 回撥函式用介詞 (before、after、on) 加動詞的名詞形式, 如 onClickButton、afterAnimation
      • 不推薦用 handleClick
   4. 鉤子函式跟 react 風格統一, 用表時態的動詞, 如 willAnimate, didAnimate
4. 縮寫
   1. 禁止所有縮寫

   let cnt, cls, btn, str // all wrong
   複製程式碼

   2. 如果某個縮寫是行業共識，則可以使用， 如 html、dom
      • 但是如果這些縮寫需要大寫、請只大寫第一個字母, 如

      let renderHtml // right
      let renderHTML // wrong
      複製程式碼

   3. 禁止用 2 標識 to, 如 string2Date 必須寫成 stringToDate