代码标记注释

在写代码时,我们经常会使用到 TODO: 标识需要完成或者代办的任务,这属于代码标记注释,常见的代码标记注释还包括:

  • TODO:用于标识需要完成或待办的任务,表示未来需要实现或改进的部分。

  • FIXME:用于标识需要修复的bug或错误,表示存在问题需要修复。

  • HACK:用于标识不太优雅或临时性的解决方案,表示代码中有一些权宜之计。

  • XXX:用于标识需要注意或潜在问题的地方,警示开发人员关注可能存在的风险。

  • IDEA:用于记录新功能、想法或改进建议,表示这里可以添加新的功能或优化。

  • REVIEW:用于标识需要进行代码审查或团队讨论的部分,帮助确定需要重点关注的内容。

  • OPTIMIZE:用于标识需要优化或提升性能的地方,提示开发人员对代码效率进行改进。

  • BUG:用于标识已知的bug或问题,有助于跟踪和管理现有的缺陷。

这些标记注释类型在实际的代码编写中经常被使用,有助于开发人员更好地组织和管理代码,提醒自己或团队成员需要注意或处理的事项,以及帮助持续改进和优化代码质量。每种类型的标记注释都有其特定的含义和用途,有助于提高代码的可读性和维护性。

如果使用 vscode 进行开发, 配合 TODO Highlight 插件是一个不错的选择,他会对不同的注释词进行不同颜色的高亮,并且是可配置的。

相关推荐
triumph_passion1 天前
ESlint9学习记录(前端编码规范化/工程化)
代码规范
Synmbrf1 天前
说说平时开发注意事项
javascript·面试·代码规范
一只叫煤球的猫2 天前
你真的会用 return 吗?—— 11个值得借鉴的 return 写法
java·后端·代码规范
Freedom风间3 天前
前端优秀编码技巧
前端·javascript·代码规范
方圆想当图灵3 天前
由 Mybatis 源码畅谈软件设计(七):SQL “染色” 拦截器实战
后端·mybatis·代码规范
这颗橘子不太甜QAQ3 天前
Husky使用技巧
javascript·git·代码规范
异常君3 天前
Java 高并发编程:等值判断的隐患与如何精确控制线程状态
java·后端·代码规范
异常君3 天前
Java 日期处理:SimpleDateFormat 线程安全问题及解决方案
java·后端·代码规范
异常君3 天前
线程池隐患解析:为何阿里巴巴拒绝 Executors
java·后端·代码规范
程序员韩立3 天前
在掘金(Juejin)上使用 Markdown、代码块和选择标签的一些关键点和技巧
代码规范