注释
现有代码基本没有注释,基本上只能看懂自己写的业务块代码,非常不利于后期维护重构。
后面请大家多加上注释,方便自己后期维护修改,也利于后期他人维护重构。
请大家先加上注释模版,加上方法如下:
打开Window->Preferences->java->code style->code Template-Comments
1. 文件 (Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author xxxx(请改为自己的名字)
*@date ${date}
*/
2.类型 (Types)注释标签(类的注释):
/**
* ClassName: ${type_name}
* @Description: ${todo}
* @author xxxx(请改为自己的名字)
* @date ${date}
*/
3.方法 (Constructor & Methods)标签:
/**
* @Description: ${todo}
* @param ${tags}
* @return ${return_type}
* @throws
* @author xxxx(请改为自己的名字)
* @date ${date}
*/