/devdoc

开发规范整理

Apache License 2.0Apache-2.0

devdoc

开发规范整理

Git管理规范

  • 分支说明
  1. master分支为发布分支
  2. dev分支为master分支的fork版本,用于开发分支
  3. feature/功能说明 此类分支为dev分支的自分支,用于开发的时候开发不同的功能。
  4. test/版本说明功能测试分支
  5. v1.0版本分支(测试通过的稳定版本,基于master分支)
  • 每次开发步骤
  1. 根据当前开发功能创建分支(基于dev分支),分支名称格式feature/功能说明
  2. 开发完成并确保独立测试成功
  3. 测试通过后将feature/功能说明分支合并到dev分支,发布一个dev分支以测试
  4. 测试通过合并devmaster
  5. 基于master创建tag用以发布

代码规范

javascript

  • 命名
  1. 通用:不允许有中文,允许拼音,所有字母小写
  2. 文件:要求名称能够描述当前文件功能;用'-'分隔单词,用'.'分隔功能(例如:weibo-list.component.js)
  3. 文件夹:要求名称能够描述当前文件功能;用'-'分隔单词(例如:weibo-list)
  4. 类命名:遵从驼峰法命名规范
  5. 方法命名:驼峰法并且首字母小写
  6. 变量命名:遵从驼峰法;私有变量应以'_'开头;确保首字母小写;

angular.x

  • 开发人员严格遵循ts语言规范
  • 提交代码之前必须先执行ng lint命令,确保所有代码pass linting再提交,lint.json
  • 变量名必须小写开头,驼峰法命名
  • 私有变量必须以 _ 开头
  • 所有的方法名称小写字母开头
  • 方法或变量名称尽量有意义,否则必须有完整的注释
  • 所有变量必须定义在构造函数之前,尽量都要有具体的类型
  • 方法的定义必须在构造之后
  • 文件名名称必须小写,- 分隔功能,. 分隔类型
  • 代码缩进统一为制表符长度4
  • 样式文件统一使用 less
  • 所有单独的功能都应该以单独的组件出现
  • 所有的 console 在用完后都应该删除或注释掉