开发规范
AprilTong
# 开发规范
# 组件
组件命名
驼峰式命名,比如 homePage 注意:引入的时候,也需要是./homePage,不能用 HomePage,否则在自动化部署的时候会报错
组件样式 单组件样式一般直接写到组件下 style 标签下,为了防止样式污染,需要添加 scoped 属性,写样式的时候尽量少写元素选择器,为了提高代码查找速度,可以用类选择器。
props 定义
当定义组件时,应该对传入组件的 props 进行严格的定义,至少指定类型,设定默认值,定义好规范方便他人使用。
举个 🌰:
visible: { type: Boolean, default: false, },
1
2
3
4
# 注释规范
代码注释在一个项目的后期维护中显的尤为重要,所以我们要为每一个被复用的组件编写组件使用说明,为组件中每一个方法编写方法说明。 以下情况,务必添加注释
1.公共组件使用说明
2.各组件中重要函数或者类说明
3.复杂的业务逻辑处理说明
4.特殊情况的代码处理说明,对于代码中特殊用途的变量、存在临界值、函数中使用的参数、使用了某种算法或思路等需要进行注释描述
5.注释块必须以/**(至少两个星号)开头**/;
6.单行注释使用//;
7.多重 if 判断语句
1
2
3
4
5
6
7
2
3
4
5
6
7