前言
在一个团队中,一般会同时有多个项目在开发,我们除了要开发自己主要负责的项目,偶尔也会因为客观因素去开发别的团队或个人主导的项目。这时问题就出现了,我们需要花一定的时间去了解项目的目录结构,并且努力遵循当前项目的一些潜在的规范(即使这些规范内心是拒绝的,为了不破坏整体性也会去遵守)。那么我们对于采用vue技术栈的项目发现有一些可以改进和规范的地方,如:文件命名不规范,开发目录结构不统一等。
目的
统一命名规范,统一开发目录结构。借用egg.js中的设计思想就是:在团队内部采用这种方式可以减少开发人员的学习成本,开发人员不再是『钉子』,可以流动起来。没有约定的团队,沟通成本是非常高的,比如有人会按目录分栈而其他人按目录分功能,开发者认知不一致很容易犯错。
文件命名规范
folder:文件夹命名采用中划线连接
反例:serviceCustomer ServiceCustomer Users uiComponents
推荐:service-customer users
.js:一般的js文件采用小驼峰的命名方式。如果是类文件,则使用大驼峰的命名方式
反例:service-customer.js
推荐:serviceCustomer.js ServiceCustomer.js(仅限类文件)
.vue:官方推荐使用大驼峰或者中划线的方式命名。单文件组件官方命名规范
反例:myComponent.vue
可使用:MyComponent.vue
推荐:my-component.vue