2015-08-29

一直用 Sublime Text 写代码,这段时间尝试使用了 WebStorm,在界面的底部看到了 TODO 的选项,好奇探索才发现原来是一种注视写法,并且还不止这一种,于是把一些常用的都查了出来。

TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。

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

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

再扒了扒,竟然还有更多的:

NOTE: Description of how the code works (when it isn't self evident)
XXX: Warning about possible pitfalls, can be used as NOTE:XXX:
HACK: Not very well written or malformed code to circumvent a problem/bug. Should be used as HACK:FIXME:
FIXME: This works, sort of, but it could be done better. (usually code written in a hurry that needs rewriting)
BUG: There is a problem here.
TODO: No problem, but addtional code needs to be written (usually when you are skipping something)

来源:http://www.cnblogs.com/lovevivi/archive/2012/11/08/2761412.html

  2015-08-29 22:55   45