命名规范
1.项目命名:全部采用驼峰式命名
2.目录,js,css,scss,html命名
vue的项目中components下的组件目录名,使用大驼峰命令,例:LeftBar
JS文件命名:参照项目命名规则(大驼峰命名)。例:AccountModel.js
CSS, SCSS文件命名:例: RetinaSprites.css
HTML文件命名:例: Errorlog.html
3.方法名,变量名 命名
方法,变量的命名一般采用(动词+名词)的方法,并用小驼峰划分语义,比如doSomething, loadData, getState, getData, parseData等等。
如果方法属于事件响应,那么建议(on+事件目标+事件名称),采用小驼峰划分语义,比如onMybtnClick, onCardboxClick, onMenuDrop等等
4.单行注释和多行注释
注释单独一行的情况下,注释的//后面要跟一个空格
多行注释:
/**
- 代码注释1
- 代码注释2
*/
建议在以下几种情况使用:
难于理解的代码段
可能存在错误的代码段
浏览器特殊的HACK代码
业务逻辑强相关的代码
函数注释
复杂的函数,所有类,都必须进行函数注释,函数注释使用业界统一的规范,方便后续使用jsdoc生成文档。
5.常量命名
常量就是初始化后不会再改变的变量,此类变量一般用全大写+下划线的方法命名。
比如
var IMAGE_SERVER = ‘http://img.alibaba.com’;
var MAX_LENGTH = 200