Git提交规范
Git Commit 规范:
1 | <type>(<scope>):<subject> |
具体里面参数的含义:
type
用于说明 commit 的类别,值允许使用下面7中标识:
- feat:新功能(featur)
- fix:修补bug
- doc:文档(documentation)
- style: 格式(不影响代码运行的变动)
- refactor:重构(即不是新增功能,也不是修改bug的代码变动)
- test:增加测试
- chore:构建过程或者辅助工具的变动
scope
用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同
subject
用于commit 目的的简单描述,不得超过50个字符。
命名规则
命名的时候,取一个好的命名是非常重要的。
类名
类名和对象名应该使用 名词或者名词短语,如 Customer、WikiPage等,避免使用 Manager、Processor、Data 或 Info这样的类名。
方法名
方法名应该是 动词或者动词短语,如postPayment、deletePage 或 save。属性访问器、修改其和断言应该根据其值命名,并咦Javabean标准加上 get、set 和 is 前缀。
函数
短小
函数代码行数尽量不要很多。
抽离 try/catch 代码块
书上说 try/catch 代码块打乱了代码结构,把错误代码处理和正常处理混为一谈。书上的建议是抽离出错误代码块,形成函数。
Reference
- 阿里巴巴Java开发手册
- 《代码整洁之道》