Java注释模版设置

设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍:

文件(Files)注释标签:

/**   
 * @Title: ${file_name} 
 * @Package ${package_name} 
 * @Description: ${todo}(用一句话描述该文件做什么) 
 * @author JoJo
 * @date ${date} ${time} 
 * @version V1.0   
 */

类型(Types)注释标签(类的注释):

/** 
 * @ClassName: ${type_name} 
 * @Description: ${todo}(这里用一句话描述这个类的作用) 
 * @author JoJo
 * @date ${date} ${time} 
 * 
 * ${tags} 
 */

字段(Fields)注释标签:

/** 
 * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) 
 */

构造函数(Constructor)标签:

/** 
 * <p>Title: </p> 
 * <p>Description: </p> 
 * ${tags} 
 */

方法(Methods)标签

/** 
 * @Title: ${enclosing_method} 
 * @Description: ${todo}(这里用一句话描述这个方法的作用) 
 * @param ${tags}    设定文件 
 * @return ${return_type}    返回类型 
 * @throws 
 */

覆盖方法(Overriding Methods)标签:

/* (非 Javadoc) 
 * <p>Title: ${enclosing_method}</p> 
 * <p>Description: </p> 
 * ${tags} 
 * ${see_to_overridden} 
 */

代表方法(Delegate Methods)标签:

/** 
 * ${tags} 
 * ${see_to_target} 
 */ 

getter方法标签:

/**
 * @return the ${bare_field_name}
 */

setter方法标签:

/**
 * @param ${param} the ${bare_field_name} to set
 */
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章