代码注释标记符说明
大约 2 分钟
"// TODO ", 标识将来要完成的内容;
"// BUG ", 该注释下方的代码存在bug
"// XXX ", 有待改进的功能。
"// FIXME", 标识以后要修正或完善的内容。
"// HACK", 该注释下方的代码需要根据自己的需求去调整程序代码
"// MARK", 做个标记,标记一件事情
"// ???", 疑问的地方
"// !!!", 需要注意的地方
代码注释
TODO
如果代码中有该注释,说明在该注释处有功能代码待编写,待实现的功能在说明中会简略说明。
FIXME
如果代码中有该注释,说明该注释处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。该处的注释在eclipse中的error tap中可以看到。
XXX
如果代码中有该注释,说明注释处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
代码注释
在阅读源码和开发过程中,都遇见过别人写的TODO注释。按照字面理解就是将要做什么,一直理解就是解释该注释下面的代码干了什么。后来不经意间看到了别人写的文章,原来不止是这么简单。下面就把我整理的一部分注释跟大家分享一下。
- TODO:该注释下方的代码将要实现的功能
- FIXME:该注释下方的代码可能不满足后来的需求,需要进行修改
- HACK:该注释下方的代码需要根据自己的需求去调整程序代码
- BUG:该注释下方的代码存在bug
这一些是我们通常约定好的注释,大家一看就能明白。其实我们也可以自定义注释,方便自己开发。
代码注释
- 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) Fuck Me
- BUG: There is a problem here.丢锅埋雷挖坑
- TODO: No problem, but addtional code needs to be written (usually when you are skipping something)情未了