代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
这个DBA有点耶6 小时前
从症状到根因:数据库监控指标的分层方法与静态/动态阈值策略
数据库·mysql·代码规范
这个DBA有点耶9 小时前
DELETE没删多少数据,表却越来越大——InnoDB删除空洞与页合并失效的根因
数据库·mysql·代码规范
深圳老胡16 小时前
RTX 与其他 RTOS 操作系统的差异及优缺点分析
笔记·stm32·单片机·代码规范
伟大的车尔尼1 天前
代码规范性与不同场景的要求
代码规范·代码·规范性
深圳老胡1 天前
C语言实现C++面向对象程序设计示例
笔记·stm32·单片机·代码规范
深圳老胡2 天前
STM32C5 系列 MCU 的 FreeRTOS 软件架构搭建指南:外设配置与应用实践
笔记·stm32·单片机·代码规范
高晶3 天前
Android 文件管理器开发实战指南
程序员·代码规范
4 天前
正则少一个 re.MULTILINE,我的安全闸门全程空转——而我以为修好了
后端·代码规范
咖啡八杯4 天前
异常体系设计:三类策略(i18n code、message、受检异常)
java·架构·代码规范
浮链序4 天前
Shopify 把 10 亿商品开放给任意 agent 了:我用零依赖 Python 撸了个带预算闸门的代购网关
后端·代码规范