该文章将列举前端编辑代码时变量
及方法
的命名规范
命名模式
A/HC/LC模式
name | prefix | A | HC | LC |
---|---|---|---|---|
getUser | User | |||
getUserMessage | get | User | Message | |
handlerClickOutside | handle | Click | Outside | |
shouldDisplayMessage | should | Display | Message |
动作类型
函数名称的动词部分,是描述函数作用的最重要的部分,如:
- getXXX,表示获取数据
- setXXX,表示设值
- resetXXX,重置数据
- fetchXXX,请求数据
- removeXXX, 移除数据,表示从某处删除某物
- deleteXXX,删除数据,表示完全清楚某些事物
- composeXXX,从现有数据创建新数据
- handleXXX,处理某个动作
前缀
前缀用来增强变量的含义,如:
- is,描述特征或状态,通常是boolean类型
- has,描述是否具有某个状态或值,通常是boolean
- should,反映肯定的条件,加上特定的执行动作
- min/max,描述便捷或界限时使用
- prev/next,指示一个或下一个状态