写给自己看的命名备忘录

如何给变量取名字

1. 如果要返回一个数据
   • 函数名字是名词
2. 如果只做事不返回

   • 函数名字是动词

react 组件内部函数声明顺序

1. static 开头的类属性，如 defaultProps、propTypes。
2. 构造函数，constructor。
3. getter/setter
4. 组件生命周期。
5. _ 开头的私有方法。
6. 事件监听方法，handle*。
7. render开头的方法，有时候 render() 方法里面的内容会分开到不同函数里面进行，这些函数都以 render 开头。
8. render() 方法

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