代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
高晶8 小时前
Android 文件管理器开发实战指南
程序员·代码规范
10 小时前
正则少一个 re.MULTILINE,我的安全闸门全程空转——而我以为修好了
后端·代码规范
咖啡八杯10 小时前
异常体系设计:三类策略(i18n code、message、受检异常)
java·架构·代码规范
浮链序1 天前
Shopify 把 10 亿商品开放给任意 agent 了:我用零依赖 Python 撸了个带预算闸门的代购网关
后端·代码规范
这个DBA有点耶2 天前
ELT 工具选型完整指南:从 ETL 差异分析到工程落地
数据库·架构·代码规范
这个DBA有点耶2 天前
分布式事务深度:TCC空回滚、悬挂与Saga补偿风暴的根因与解法
数据库·mysql·代码规范
这个DBA有点耶4 天前
为什么UPDATE比SELECT危险得多?锁范围等于扫描行数
数据库·架构·代码规范
沈麽鬼4 天前
纸上代码
代码规范
深圳老胡6 天前
STM32CubeMX 生成 CMake 工程,用 VSCode 编译与调试的完整流程
笔记·stm32·单片机·代码规范
星星泡饭吃6 天前
【信息安全】越权防护设计评审指南
代码规范