代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
realhuizhu3 天前
代码考古学:如何让你的代码不再是“未解之谜”?
代码规范·团队协作·技术文档·ai工具·程序员自我修养
潇湘梦3 天前
mysql团队编写规范
数据库·mysql·代码规范
jump_jump3 天前
Grit:代码重构利器
性能优化·rust·代码规范
freeWayWalker4 天前
【前端工程化】前端代码规范与静态检查
前端·代码规范
realze9 天前
关于我80%的代码都用AI生成这件事
人工智能·代码规范·全栈
于谦9 天前
✨ feat(app1,pkg1): monorepo生成规范化提交信息的最优解 - committier
javascript·github·代码规范
帅次9 天前
系统分析师:软件需求工程的需求定义、需求验证和需求管理
软件工程·软件构建·需求分析·代码规范·设计规范·规格说明书·代码复审
Crystal32810 天前
图片懒加载
前端·javascript·代码规范
Hilaku11 天前
那个把代码写得亲妈都不认的同事,最后被劝退了🤷‍♂️
前端·javascript·代码规范