代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
我是若尘2 天前
我的需求代码被主干 revert 了,接下来我该怎么操作?
前端·后端·代码规范
方安乐2 天前
ESLint代码规范(二)
前端·javascript·代码规范
三声三视4 天前
从“Vibe Coding“到生产事故:为什么你的AI代码正在埋雷?——AI时代规范驱动开发的生存指南
人工智能·ai编程·代码规范
假面骑士阿猫4 天前
TRAE配置OpenSpec实现SDD规范驱动开发
前端·人工智能·代码规范
ruanCat4 天前
前端工程化工具链从零配置:simple-git-hooks + lint-staged + commitlint
前端·git·代码规范
两万五千个小时5 天前
解析 OpenClaw AgentSkills:AI Agent 如何通过「技能包」实现专业化
人工智能·程序员·代码规范
hbstream6 天前
我让 Claude 和 Codex 同时审计 26 个模块,它们只在 10 个上达成共识
ai编程·代码规范
方安乐8 天前
ESLint代码规范(一)
前端·javascript·代码规范
Re_zero8 天前
throws 还是 try-catch?Code Review 里被我打回最多的异常处理
java·代码规范
集成显卡8 天前
别局限于 Oh-My-Posh,试试 Rust 编写的 starship:极简超快且无限可定制的命令行提示符
程序员·代码规范·命令行