代码标记注释

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

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

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

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

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

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

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

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

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

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

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

相关推荐
那个下雨天2 天前
护城河式编程模式:黑色幽默中的工程生存学
职场发展·代码规范·护城河式编程·职场心得
想用offer打牌4 天前
线程池踩坑之一:将其放在类的成员变量
后端·面试·代码规范
幻灵尔依8 天前
前端编码统一规范
javascript·vue.js·代码规范
薛定谔的猫28 天前
前端工程化系列(一):编码规范相关
前端·代码规范·前端工程化
围巾哥萧尘8 天前
Batchify - AI 产品镜头生成器的产品经验🧣
代码规范
Hilaku8 天前
深入URL和URLSearchParams:别再用正则表达式去折磨URL了
前端·javascript·代码规范
艾小码8 天前
代码审查总得罪人?3个技巧让你成为团队最受欢迎的技术大佬!
代码规范
不知名程序员第二部9 天前
前端-业务-架构
前端·javascript·代码规范
码间舞10 天前
你不知道的pnpm!如果我的电脑上安装了nvm,切换node版本后,那么pnpm还会共享一个磁盘的npm包吗?
前端·代码规范·前端工程化
shellvon10 天前
HTTP 请求头大小写差异:一次由 Clash 代理引发的疑难杂症
代码规范