前端代码管理规范

一、命名规则

1、文件/文件夹命名

文件夹/文件的命名统一用小写 或驼峰

项目名称一律小写或带_ 下划线 连接

2、js变量

3.1 变量 ——命名方式:小驼峰 ; 命名规范:前缀名词

3.2 常量 —— 命名方式: 使用大写字母和下划线来组合命名

3.3 函数 —— 命名方式:小驼峰 ;命名规范:前缀动词

3.4 类、构造函数 —— 命名方式:大驼峰式命名法,首字母大写

3.5 css(class、id)命名规则BEM

.block{} // 代表了最高级别的组件
.block__element{} // 代表 block 的后代
.block--modifier{} // 代表 block 的不同状态或不同版本

二、注释

1.单行注释 —— // 说明

2.多行注释 ——

/*
* xxxx 描述较多的时候可以使用多行注释
* xxxx
*/

三、组件

每个 Vue 组件的代码建议不要超出 300 行 (建议父子组件组合或抽离成公共组件)

四、codeReview

  1. 所有影响到以往流程的功能需求更改发版前都需要codeReview ;

  2. 初级程序员可由中级程序员的执行codeReview

中级程序员可由高级程序员执行codeReview

以此类推

五、git规范

  1. 分支

master ——只有管理员才能操作

develop ——开发分支

test ——测试分支

  1. 提交

提交前要写备注(当前提交的具体内容)

你可能感兴趣的:(前端代码管理规范)