开发规范整理
- 分支说明
master
分支为发布分支dev
分支为master分支的fork版本,用于开发分支feature/功能说明
此类分支为dev
分支的自分支,用于开发的时候开发不同的功能。test/版本说明
功能测试分支v1.0
版本分支(测试通过的稳定版本,基于master
分支)
- 每次开发步骤
- 根据当前开发功能创建分支(基于
dev
分支),分支名称格式feature/功能说明
- 开发完成并确保独立测试成功
- 测试通过后将
feature/功能说明
分支合并到dev
分支,发布一个dev
分支以测试 - 测试通过合并
dev
到master
- 基于
master
创建tag用以发布
- 命名
- 通用:不允许有中文,允许拼音,所有字母小写
- 文件:要求名称能够描述当前文件功能;用'-'分隔单词,用'.'分隔功能(例如:weibo-list.component.js)
- 文件夹:要求名称能够描述当前文件功能;用'-'分隔单词(例如:weibo-list)
- 类命名:遵从驼峰法命名规范
- 方法命名:驼峰法并且首字母小写
- 变量命名:遵从驼峰法;私有变量应以'_'开头;确保首字母小写;
- 开发人员严格遵循ts语言规范
- 提交代码之前必须先执行
ng lint
命令,确保所有代码pass linting
再提交,lint.json - 变量名必须小写开头,驼峰法命名
- 私有变量必须以
_
开头 - 所有的方法名称小写字母开头
- 方法或变量名称尽量有意义,否则必须有完整的注释
- 所有变量必须定义在构造函数之前,尽量都要有具体的类型
- 方法的定义必须在构造之后
- 文件名名称必须小写,
-
分隔功能,.
分隔类型 - 代码缩进统一为制表符长度
4
- 样式文件统一使用
less
- 所有单独的功能都应该以单独的组件出现
- 所有的
console
在用完后都应该删除或注释掉