提交代码注释规范

Posted 阳光下的行者

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了提交代码注释规范相关的知识,希望对你有一定的参考价值。

提交代码注释规范
- feat: 新增feature
- fix: 修复bug
- docs: 仅仅修改了文档,比如README、CHANGELOG、CONTRIBUTE等等
- style: 仅仅修改了空格、格式所以进、变量名等等,不改变代码逻辑
- refactor: 代码重构、没有加新功能或者修复bug
- perf: 优化相关,比如提升性能、体验
- test: 测试用例,包括单元测试、继承测试等
- chore: 改变构建流程、或者依赖库、工具等
- revert: 回滚到上一个版本
- merge: 代码合并同步

以上是关于提交代码注释规范的主要内容,如果未能解决你的问题,请参考以下文章

DigApis编码提交规范白皮书

Git规范的必要性

Code Review 规范

Go 语言编程规范

如何获取java代码中的注释

JIRA注释规范