文件(Files)注释标签:
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* Copyright: Copyright (c) 2013
* Company:星辉科技(北京)有限责任公司
*
* @author Lucy-${user}
* @date ${date} ${time}
* @version V1.0
*/
类型(Types)注释标签(类的注释):
/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author Comsys-${user}
* @date ${date} ${time}
*
* ${tags}
*/
字段(Fields)注释标签:
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
构造函数标签:
/**
* 创建一个新的实例 ${enclosing_type}.
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
方法(Constructor & Methods)标签:
/**
* ${enclosing_method}(这里用一句话描述这个方法的作用)
* ${todo}(这里描述这个方法适用条件 – 可选)
* ${todo}(这里描述这个方法的执行流程 – 可选)
* ${todo}(这里描述这个方法的使用方法 – 可选)
* ${todo}(这里描述这个方法的注意事项 – 可选)
*
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
覆盖方法(Overriding Methods)标签:
/*
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
代表方法(Delegate Methods)标签:
/**
* ${tags}
* ${see_to_target}
*/