代码中特殊的注释技术

Posted LiGengMing

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了代码中特殊的注释技术相关的知识,希望对你有一定的参考价值。

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

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

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

eclipse中特殊的注释:
在eclipse中,TODO、FIXME和XXX都会被eclipse的task视图所收集。在项目发布前,检查一下task视图是一个很好的习惯。此外,在eclipse中,我们可自定义自己的特殊注释标签。如在C/C++中,进入window—>preferences—>C/C++—>Task Tags窗口即可添加特殊标签,默认只有TODO、FIXME和XXX

以上是关于代码中特殊的注释技术的主要内容,如果未能解决你的问题,请参考以下文章

Java代码中特殊注释

Eclipse中的特殊注释:TODOXXXFIXME

代码中三种特殊注释——TODOFIXMEXXX

java特殊注释

java特殊注释

注释的基本使用与文档注释的特殊功能