代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
闲不住的李先森13 小时前
使用 Ultracite 告别 ESLint 和 Prettier 的配置地狱
前端·代码规范
回家路上绕了弯1 天前
追求代码简洁之道:我的实践与感悟
后端·代码规范
前端伪大叔1 天前
第 5 篇:策略参数怎么调优?Freqtrade hyperopt 快速入门
算法·代码规范
每天开心2 天前
告别样式冲突:CSS 模块化实战
前端·css·代码规范
一语长情3 天前
从《架构整洁之道》看编程范式:结构化、面向对象与函数式编程精要
后端·架构·代码规范
Point3 天前
[ahooks] useRequest源码阅读(二)
前端·javascript·代码规范
用户48199163673874 天前
🚀 Vue3 高级组件封装实践指南:让你的组件更优雅、更好用
vue.js·代码规范
Hilaku4 天前
别再手写i18n了!深入浏览器原生Intl对象(数字、日期、复数处理)
前端·javascript·代码规范
葡萄城技术团队4 天前
什么是卓越的开发者体验(Developer Experience)?
代码规范