常用的代码注释标签

  • TODO - 表示这里有待完成的任务或者待实现的功能。

  • FIXME - 指出代码中存在问题或bug,需要修复的地方。

  • XXX - 表示代码可能包含临时解决方案、糟糕的实践、或者有待优化的部分,通常意味着此处的实现方式并不理想,应在未来重新审视和改进。

除此之外,还有其他一些非标准但同样常用的注释标签:

  • HACK 或 HACKER - 标记一段临时性的、非常规的解决方案,通常用于应对紧急问题,但长期来看不是最优解。

  • OPTIMIZE 或 PERFORMANCE - 标记可能影响性能的地方,需要进一步优化。

  • REVIEW - 请求他人复查某段代码,可能是为了确认设计决策、逻辑是否正确或改进代码质量。

  • DEPRECATED - 标记已弃用的代码,提醒开发者这段代码未来可能会被移除。

  • NOTE 或 NOTICE - 添加一些说明文字,提供一些重要提示或背景信息。

  • INFO : 用来表达一些信息。

  • TAG : 用来创建一些标记。

  • BUG : 用来标记BUG~

  • UNDONE 或 WIP (Work In Progress) - 标记正在进行的工作,表明这部分代码尚未完成。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值