代码注释规范

Posted 2020-12-25 mrblue

规范说明：

1. 关键字用[]括起来
2. 关键字和标题之间用一个空格
3. 标题不要使用句号结尾
4. 标题不超过50个字符。
5. 正文与标题另外起换行。
6. 正文解释是什么和为什么，而不是如何做。

关键字：

• [add] 新增
  
• [update] 修改
  
• [delete] 删除
  
• [fix] 修复
  
• [doc] 文档
  
• [style] 格式
  
• [refactor] 重构
  
• [test] 增加测试
  
• [tool] 工具相关

例子：

1. [add] 开放平台验证接口
2. [update] Token类实现修改为使用子类继承
   支援多种Token调用
3. [delete] Timer类
   已经被TimerManager替换
4. [fix] 验证码短信文字乱码问题
5. [doc] README.rd