注释要规范
(1)在文件开头的注释信息包括
- 功能
- 作者
- 开发时间
- 备注(可选)
(2)重要的属性信息注释,特别是data的属性、methods的方法
(3)重要的逻辑语句要做注释
(4)html文档结构注释
命名规范
(1)html的节点全部小写,属性值使用双引号("")
(2)javascript代码命名规范
- key使用小驼峰命名 例如:myName
- 变量名 小驼峰
- 方法名称小驼峰
- 类名、构造方法大驼峰
(3)样式命名规范
- 采用短横杠分隔每个单词
- 全部采用小写
- 名称要有意义,尽量按照功能来命名,功能模块下的样式,都是功能模块名称的后代选择器
- 所有的样式都写在私有样式表,<style scope></style>
(4) 方法命名
- 方法名称采用动词或形容词,而不是名词。命名要做到望文见意。
(5)属性命名
- 属性名称采用名词,单词要有意义,并且加上注释。
v-for使用规范
为了避免重复的渲染数据,要给key加上一个值,但不是index,这个最好是对象本身能够唯一标识的值,通常是主键。
另外参数要带上小括号,例如 v-for="(item,index) in items"
布局规范
(1) 页面出现的颜色不要太多,我们的主色调是灰色,确定按钮 primary 删除 danger 保存 success。
(2)背景和字体颜色要搭配,颜色能够互补,不要采用相同色系的颜色。
(3)组件通常是small、middle、mini ,一个页面只能出现large。如果都是超大尺寸,就没有重点(重点不突出)。
(4)间隙,文字、组件之间要有一定的间隙,可以通过margin、padding方式做到。
(5)超链接尽量去掉下划线,要突出的颜色用浅蓝,默认颜色灰色
(6)不是重点内容(文字)颜色要浅一点,#777 #999 ,要突出的颜色使用 #333 #555 。要特别显眼的颜色,采用橘红色、深蓝。
(7)边框样式,1px solid #ccc #ddd 这些比较浅灰颜色
this使用规范
this关键字不能滥用,因为this关键字在使用之前,要根据所在的上下文,根据作用域链查找。所以想把this的引用存起来,例如 var that=this;
axios调用接口规范
可以是this.axios或this.$http 调用,但是要加上catch()来处理接口出错的情况。
代码重用规范
(1)相同功能代码重用,如果一个项目有多个重复的功能,就应该对他做封装处理,封装到CommonUtil.js。
(2)组件封装,在项目中要使用相同UI的时候,需要封装组件。要定义好公共属性、事件、v-model。
代码格式规范
(1)代码要对齐,可以采用格式化工具完成,alt+shif+f 格式代码。vscode需要安装插件。
(2)如果格式化工具做不到的地方,就需要人为调整代码,做到代码整体一致,工整好看。
(3)json格式,如果有多个key,一行一个key的显示,而不是折叠在同一行 。
判断条件
判断条件的常量放在前面,变量放在后面,优化编译器的处理。
不规范的方式
if (this.activeName == "second") {
this.showShutup();
}
规范的代码
if ("second" == this.activeName) {
this.showShutup();
}