参考网址:

(130条消息) 编程规范: 代码中特殊注释TODO、FIXME、XXX 的含义_nohysiwe的博客-CSDN博客_golang 注释todo

(130条消息) Java XXX,TODO,FIXME 使用说明_聪鸟后飞的博客-CSDN博客

简单实例

NOTE: <说明>
对代码如何工作的描述(当它不是不言自明时)。
TODO: <说明>
通常写在一些函数的上方或者内部，当然，实际上你可想写哪儿就写哪儿。它表示该注释标识处，有一些代码功能还未实现，未来会实现，<说明> 中应该简单描述下该功能。
FIXME: <说明>
该注释表示该注释标记处的代码有问题或者是错误的，有可能无法正常工作，需要修复，<说明> 中应该简单描述下如何修复该问题。
XXX: <说明>
该注释表示该注释标记处的代码功能虽然实现了，但是实现的方式可能并不那么的好，可以进行一些改进优化，<说明> 中应该简单描述下改进优化的策略。
HACK: <说明>
没有很好地编写或不规范的代码来规避问题/bug。应该被用作HACK:FIXME:
BUG: <说明>
这里有个大bug