代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
Dr_哈哈5 天前
ESLint 9.0版本踩坑记录
vue.js·代码规范·eslint
Zbin6 天前
你了解《重构》吗?
代码规范
仁希'6 天前
clean code-代码整洁之道 阅读笔记(第十三章)
笔记·代码规范
晚风予星6 天前
Git commit 规范化提交指南
前端·代码规范
值得学清单8 天前
Vue3 中的组合式函数(Composables)
javascript·vue.js·代码规范
祯民9 天前
今天犯了一个很蠢的“错误“- React钩子dependencies参数如何“监听”某函数返回值变化?
前端·react.js·代码规范
见方天地10 天前
EV代码签名——消除软件下载时的安全警告
安全·ssl·代码规范
向阳逐梦11 天前
LDO电源模块如何快速设计布局
算法·架构·代码规范
仁希'11 天前
clean code-代码整洁之道 阅读笔记(第十二章)
笔记·代码规范
仁希'16 天前
clean code-代码整洁之道 阅读笔记(第九章)
笔记·代码规范