代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
这个DBA有点耶21 小时前
分组排名不用窗口函数?那你还在写几十行的子查询
前端·代码规范
这个DBA有点耶1 天前
两张百万级大表JOIN跑崩了?试试这3招
数据库·代码规范
得物技术1 天前
网关路由 AI 安全审计:智能漏洞检测实践|得物技术
程序员·ai编程·代码规范
这个DBA有点耶2 天前
3步抓出慢SQL,别等半夜被叫醒😴
数据库·代码规范
Jesse1215 天前
lint-staged与ls-lint配合使用时的陷阱
代码规范·命令行
电子科技圈8 天前
IAR作为Qt Group独立BU携两项重磅汽车电子应用开发方案首秀北京车展
开发语言·人工智能·汽车·软件工程·软件构建·代码规范·设计规范
Fate_I_C9 天前
Android函数式编程代码规范文档
android·代码规范
Fate_I_C9 天前
Kotlin 协程:串行/并行请求、async/await、coroutineScope 管理并发、重试机制
android·代码规范
东方隐侠安全团队-千里11 天前
DataGear 源码审计记录:我重点看了两条危险链
安全·代码规范·代码复审
程序员cxuan15 天前
10 个贼爽的 workflow 工作流
后端·程序员·代码规范