常见的注释标签的意义如下:
标签 | 意义 |
TODO | 标记代码中需要实现的功能或任务 |
XXX | 标记需要警惕或需要重点关注的代码块 |
FIXME | 标记代码中需要修复的问题或缺陷 |
BUG/DEBUG | 标记已知的Bug或错误 |
HACK/BODGE/KLUDGE | 标记临时性修复或不优雅的解决方案 |
UNDONE | 对之前代码改动的撤销 |
NOTE | 提供额外的注释或提示信息,帮助理解代码意图或设计决策 |
这些是注释中的标签(tag),有时也被称作“代码标签(codetag)”或“标记(token)”。
虽然它们在编写代码中属于非正式使用的记号,但仍有一定的价值——在个人独立开发一个项目,或者多人共同管理的开源项目中,除了能让代码编写者在代码中给自己或他人一些提示之外,也能起到对常见问题索引和快速定位的作用。
在大多数 IDE 或文本编辑器当中,以如上所述标签作为开头的注释,也会有特殊的语法高亮(syntax highlighting)。
参考链接: