代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
学渣超1 天前
记一次复杂业务功能重构——从过程式长链路,到模板方法构建体系
java·架构·代码规范
天涯浪客3 天前
我的漏洞扫描器,把被测项目的源码写坏了
代码规范
事圆则缓3 天前
遗留项目改造实战指南:从可读性、代码质量到性能和 AI 约束
android·ai·代码规范
乱码三千3 天前
开发了一套AI智能体协作知识体系
人工智能·架构·代码规范
梦梦代码精5 天前
《回收租赁系统技术选型避坑指南:业务闭环与二开自由度详解》
开发语言·低代码·docker·开源·代码规范
这个DBA有点耶6 天前
临时表从4.7秒到0.12秒:不是所有Using temporary都需要优化
数据库·mysql·代码规范
泛联新安6 天前
“天神”空降:泛联新安受邀参加第八届“纵横”网络空间创新论坛
网络安全·自动化·代码规范·漏洞挖掘·代码安全·代码漏洞扫描·ai+可信开发
用户970161501686 天前
浏览器切到后台后,AI 给我的代码就失效了:我拿 3 个模型测了 6 个定时器坑
前端·代码规范
RunProof可证工程6 天前
AI 写的登录接口能跑,上线前我却查出 SQL 注入写法
sql·代码规范
咖啡八杯7 天前
实体基类设计:BaseEntity 公共字段抽取与 TreeEntity 树形继承
java·架构·代码规范