转载请注明出处:http://blog.csdn/zhuwentao2150/article/details/51324314


我们在写代码的时候,如果突然有事要离开工位,或者下班要回家,或者去修改之前写的代码了,或者一些灵光一闪的好点子等等。。。

这些事情很容易打断我们思路,就算你进行了注释也可能很快就忘了

这个时候我们可以使用TODO、FIXME、XXX标记帮我们记下这些事情:

TODO:

// TODO: 待办事项

有功能代码还没编写,待编写的功能会在说明中简要提出。

FIXME:

// FIXME: 有待商榷的代码

比较糟糕的代码,需要进行修正,该代码可能是错误的、不能工作的,需要进行修改。

XXX:

// XXX: 可以进一步改进的代码

代码实现了功能,但是希望能进一步的改进它。


这些标记在有些IDE中是高亮显示的,特别显眼

AndroidStudio在TODO里很快就可以找到它们


滚动条里也会有高亮配色


这样我们就不用担心会遗漏Bug,遗忘灵光一闪的好点子了,是不是很赞!

更多推荐

代码编写小技巧-巧用注释