本文主要内容为博主超高校级的社畜所作,本人仅做了文本格式调整。

一、引言

之前翻看别人代码的时候,发现代码中细节慢慢,尤其是注释让我眼前一亮,所以满怀好奇地去查了一下python中注释的小秘密。

二、正文

  1. TODO: 明天再说 No problem, but addtional code needs to be written (usually when you are skipping something)

标识处有功能代码待编写,待实现的功能在说明中会简略说明。

  1. FIXME: 下次一定 This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting)

标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。

  1. XXX: 莫挨老子 Warning about possible pitfalls, can be used as NOTE:XXX: I don't know how, but it works.

标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。

  1. NOTE: 汝等凡人 Description of how the code works (when it isn’t self evident)

  2. HACK: 补锅踩雷填坑 Not very well written or malformed code to circumvent a problem/bug. Should be used as HACK:FIXME

  3. BUG: 丢锅埋雷挖坑 There is a problem here.

==另外,这些原本是eclipse中的Task Tags,并非Python专有。==