代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
东方隐侠安全团队-千里2 天前
DataGear 源码审计记录:我重点看了两条危险链
安全·代码规范·代码复审
程序员cxuan6 天前
10 个贼爽的 workflow 工作流
后端·程序员·代码规范
孜孜不倦不忘初心8 天前
Vue 项目结构与命名规范
vue.js·代码规范
Hilaku8 天前
做中后台业务,为什么我不建议你用 Tailwind CSS?
前端·css·代码规范
leonkay9 天前
到底应不应该写注释?
性能优化·架构·个人开发·注释·代码规范·设计·规格说明书
catch_pig10 天前
告别繁琐配置:Catchpig Detekt Plugin 让 Kotlin/Android 代码检查开箱即用
kotlin·android studio·代码规范
steem_ding10 天前
AI-代码扫描工具
代码规范
数据学徒工11 天前
20-Decisions Dashboard:仪表板从入门到实战
低代码·自动化·代码规范·敏捷流程
在西安放羊的牛油果13 天前
Connect 源码深度解析
前端·架构·代码规范
Freak嵌入式13 天前
小作坊 GitHub 协作闭环:fork-sync-dev-pr-merge 实战指南
python·github·远程工作·代码规范·micropython·协作