为你的Java代码配上类模块注释模板


众所周知软件开发中,注释的重要性,但是频繁地写:autor, date 等信息显然是一件痛苦的事情,那么在eclipse中,有没有什么功能能帮我们做这件事情呢?? 

为eclipse工具修改java对应类注释的template(模板) 

类注释模板的设置方法:

在eclipse / myeclipse中:菜单项Window --> Preferences --> Java --> Code Style --> Code Template --> Comments --> Types 然后选择Edit

之后剩下的只要edit的时候写入你想要的类注释的模板便可以了

我这里提供几个我自己用的模板:

模板1:

 /*******************************************************************************************
 * 类描述:
 *
 * @author: ${user}
 * @date: ${date} ${time}
 * ${tags}
 * @version 1.0
 *
 *
 * Version    Date      ModifiedBy                Content
 * -------- ---------    ----------        ------------------------
 * 1.0      ${date}      ${user}                           
 *******************************************************************************************
 */

模板1效果:

/**
* *****************************************************************************************
* 类描述:
*
* @author: 逍遥梦
* @date: 2014-2-22 上午10:38:41
* @version 1.0
*
*
* Version Date ModifiedBy Content
* -------- --------- ---------- -----------------------
* 1.0 2014-2-22 逍遥梦
*******************************************************************************************
*/

 

模板2(个人比较喜欢):

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

模板2效果:

/**
*
*
* Simple to Introduction
* @ProjectName: [EmpMis]
* @Package: [cn.xym.empmis.service.impl]
* @ClassName: [BussinessServiceImpl]
* @Description: [一句话描述该类的功能]
* @Author: [Administrator]
* @CreateDate: [2014-2-22 上午10:56:16]
* @UpdateUser: [Administrator]
* @UpdateDate: [2014-2-22 上午10:56:16]
* @UpdateRemark: [说明本次修改内容]
* @Version: [v1.0]
*
*/

 

模板3:

 /** 
  *
  * Simple To Introduction
  * 项目名称:  [${project_name}]
  * 包:        [${package_name}]   
  * 类名称:    [${type_name}] 
  * 类描述:    [一句话描述该类的功能]
  * 创建人:    [${user}] 
  * 创建时间:  [${date} ${time}] 
  * 修改人:    [${user}] 
  * 修改时间:  [${date} ${time}] 
  * 修改备注:  [说明本次修改内容] 
  * 版本:      [v1.0] 
  *   
  */

模板3效果:

/**
*
* Simple To Introduction
* 项目名称: [EmpMis]
* 包: [cn.xym.empmis.service.impl]
* 类名称: [BussinessServiceImpl]
* 类描述: [一句话描述该类的功能]
* 创建人: [Administrator]
* 创建时间: [2014-2-22 上午10:58:49]
* 修改人: [Administrator]
* 修改时间: [2014-2-22 上午10:58:49]
* 修改备注: [说明本次修改内容]
* 版本: [v1.0]
*
*/

相关内容

    暂无相关文章