Skip to content

Latest commit

 

History

History
13 lines (9 loc) · 769 Bytes

注释规范.md

File metadata and controls

13 lines (9 loc) · 769 Bytes

代码特殊标记注释

  1. **TODO ** 在该注释处有功能代码待编写,待实现的功能在说明中会简略说明
  2. **FIXME ** 在该注释处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明
  3. **XXX ** 在该注释处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明
  4. **NOTE ** 在该注释处说明代码如何工作
  5. **HACK ** 在该注释处编写得不好或格式错误,需要根据自己的需求去调整程序代码
  6. **BUG ** 在该注释处有 Bug

注释插件

插件名:koroFileHeader 添加文件头、函数注释(文件类型无限制),文件以该插件注释