python特别注释

python特别注释

一次偶然翻看pip包的时候，发现作者代码里的注释竟然支持高亮语法，骚话连篇，这里整理一下支持的关键字。

TODO: 明天再说

No problem, but addtional code needs to be written (usually when you are skipping something)

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

FIXME: 下次一定

This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting)

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

XXX: 莫挨老子

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

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

NOTE: 汝等凡人

Description of how the code works (when it isn’t self evident)

HACK: 补锅踩雷填坑

Not very well written or malformed code to circumvent a problem/bug. Should be used as HACK:FIXME

BUG: 丢锅埋雷挖坑

There is a problem here.

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

部分IDE也支持tag导航，用好这些code review炫酷十倍。