设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素。
2.1. 文件注释
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句话描述该文件做什么)
* @author A18ccms A18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
2.2. 类注释
/**
* @ClassName: ${type_name}
* @Description: ${todo}(这里用一句话描述这个类的作用)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
* ${tags}
*/
2.3. 字段注释
/**
* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
2.4. 构造函数注释
/**
* <p>Title: </p>
* <p>Description: </p>
* ${tags}
*/
2.5. 方法注释
/**
* @Title: ${enclosing_method}
* @Description: ${todo}(这里用一句话描述这个方法的作用)
* @param ${tags} 设定文件
* @return ${return_type} 返回类型
* @throws
*/
2.6. 覆盖方法注释
/* (非 Javadoc)
* <p>Title: ${enclosing_method}</p>
* <p>Description: </p>
* ${tags}
* ${see_to_overridden}
*/
2.7. 代表方法注释
/**
* ${tags}
* ${see_to_target}
*/
2.8. getter方法注释
/**
* @return ${bare_field_name}
*/
2.9. setter方法注释
/**
* @param ${param} 要设置的 ${bare_field_name}
*/