时间长了,我们程序员总会在阅读别人(大神或大大神)的代码时都会遇到一些特殊的注释代码,其中的含义也有许多不同,下面时我找到的一些常用的代码注释分享给大家。(包括 js 和 html 等代码)
TODO: + 说明:
如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME: + 说明:
如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
XXX: + 说明:
如果代码中有该标识,说明标识处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
eclipse 中特殊的注释:
在 eclipse 中,TODO、FIXME 和 XXX 都会被 eclipse 的 task 视图所收集。在项目发布前,检查一下 task 视图是一个很好的习惯。此外,在 eclipse 中,我们可自定义自己的特殊注释标签。如在 C/C++ 中,进入 window—>preferences—>C/C++—>Task
Tags 窗口即可添加特殊标签,默认只有 TODO、FIXME 和 XXX。
欢迎来到这里!
我们正在构建一个小众社区,大家在这里相互信任,以平等 • 自由 • 奔放的价值观进行分享交流。最终,希望大家能够找到与自己志同道合的伙伴,共同成长。
注册 关于