代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
viva51724 天前
常用编码规范/Format规约
代码规范
viva51724 天前
常用编码规范/命名规约
代码规范
HLAIA光子5 天前
AI 编程提效的困局:为什么出码率上去了,效率却没来?
ai编程·代码规范
Code_Artist7 天前
线程池的终结?协程/纤程/虚拟线程带来的并发范式变化!
后端·架构·代码规范
Jinuss7 天前
代码质量管理工具-SonarQube
前端·代码规范
Csvn8 天前
实用的 AI 辅助编程技巧和最佳实践
人工智能·代码规范
Supersist9 天前
【设计模式03】使用模版模式+责任链模式优化实战
后端·设计模式·代码规范
jump_jump10 天前
把一份前端 checklist 变成 AI 的 Skill:让 CR 不再靠记忆
性能优化·ai编程·代码规范
jump_jump11 天前
TSRX:一份源码,编译到 React / Solid / Vue / Preact / Ripple
前端框架·代码规范·编译器