Python代码中的标签

常见的注释标签的意义如下:

标签意义
TODO标记代码中需要实现的功能或任务
XXX标记需要警惕或需要重点关注的代码块
FIXME标记代码中需要修复的问题或缺陷
BUG/DEBUG标记已知的Bug或错误
HACK/BODGE/KLUDGE标记临时性修复或不优雅的解决方案
UNDONE对之前代码改动的撤销
NOTE提供额外的注释或提示信息,帮助理解代码意图或设计决策

       这些是注释中的标签(tag),有时也被称作“代码标签(codetag)”或“标记(token)”。

       虽然它们在编写代码中属于非正式使用的记号,但仍有一定的价值——在个人独立开发一个项目,或者多人共同管理的开源项目中,除了能让代码编写者在代码中给自己或他人一些提示之外,也能起到对常见问题索引和快速定位的作用。

       在大多数 IDE 或文本编辑器当中,以如上所述标签作为开头的注释,也会有特殊的语法高亮(syntax highlighting)。

参考链接:

代码注释中经常用到的 TODO、XXX、FIXME 有什么区别? - 知乎知乎,中文互联网高质量的问答社区和创作者聚集的原创内容平台,于 2011 年 1 月正式上线,以「让人们更好的分享知识、经验和见解,找到自己的解答」为品牌使命。知乎凭借认真、专业、友善的社区氛围、独特的产品机制以及结构化和易获得的优质内容,聚集了中文互联网科技、商业、影视、时尚、文化等领域最具创造力的人群,已成为综合性、全品类、在诸多领域具有关键影响力的知识分享社区和创作者聚集的原创内容平台,建立起了以社区驱动的内容变现商业模式。icon-default.png?t=N7T8https://www.zhihu.com/question/19563346

  • 4
    点赞
  • 7
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值