代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
阿俊-全栈开发10 小时前
LikeShop 二开代码规范:目录结构、钩子使用与版本升级兼容方案
代码规范·likeshop开源商城·likeshop单商户标准版·多商户源码
深圳老胡11 小时前
STM32 开发中 Trae 内置模型怎么选:Seed、MiniMax、GLM、DeepSeek、Kimi、Qwen 全对比
笔记·stm32·单片机·嵌入式硬件·代码规范·1024程序员节
喵个咪1 天前
AI 时代的危与机:当潮水退去,技术人如何自处
ai编程·代码规范
六个蒙多都说少之一拳下去那得是1 天前
Git 与 GitHub 从零到协作:核心操作完全指南
github·代码规范
hunter_0761 天前
App 被苹果 4.3 拒绝怎么办?从官方条款到整改、沟通与申诉
面试·代码规范
深圳老胡2 天前
STM32 工程在 VSCode 中用 AI 搭建软件骨架架构:从零到可运行的分层实践
笔记·stm32·单片机·代码规范
深圳老胡2 天前
STM32 工程在 VS Code 中的编译与调试:AI 辅助工具实战指南
笔记·stm32·单片机·代码规范
这个DBA有点耶2 天前
索引建了查询却更慢——优化器选错索引与Index Merge的隐藏代价
数据库·架构·代码规范
深圳老胡2 天前
STM32CubeMX 2 与 STM32CubeMX 的主要区别
笔记·stm32·单片机·代码规范
深圳老胡3 天前
STM32C5A3ZG开发板:基于STM32CubeMX与VSCode的按键检测与LED闪烁实战
笔记·stm32·单片机·代码规范