修改注释模板

来源:互联网 发布:sql case when 多表 编辑:程序博客网 时间:2024/06/07 00:15
设置注释模板的入口: Window->Preference->Java->Code Style->Code Template 
然后展开Comments节点就是所有需设置注释的元素。现就每一个元素逐一介绍:


文件(Files)注释标签:


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


/**   
* @Description: 
* @Package ${package_name} 
* @date ${date} ${time} 
* @version V1.0   
*/


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


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

* ${tags} 
*/


字段(Fields)注释标签:


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


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


方法(Constructor & 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 ${bare_field_name} 
*/


setter方法标签:


/** 
* @param ${param} 要设置的 ${bare_field_name} 
*/




----------------------------------------------------------------------------------
/**   
 *  
 * Simple to Introduction  
 * @ProjectName:  [${project_name}] 
 * @Package:      [${package_name}.${file_name}]  
 * @ClassName:    [${type_name}]   
 * @Description:  [一句话描述该类的功能]   
 * @Author:       [${user}]   
 * @CreateDate:   [${date} ${time}]   
 * @UpdateUser:   [${user}]   
 * @UpdateDate:   [${date} ${time}]   
 * @UpdateRemark: [说明本次修改内容]  
 * @Version:      [v1.0] 
 *    

 */


0 0
原创粉丝点击