myeclipse中java注釋格式設置，myeclipsejava

myeclipse中java注釋格式設置，myeclipsejava

Eclipse注釋規范模版總結

一、具體操作

（1）在eclipse中，打開Window->Preference->Java->Code Style->Code Template

（2）然後展開Comments節點就是所有需設置注釋的元素，參照下面注釋規范對應設置即可

二、注釋規范

1、文件(Files)注釋標簽

/**
 * FileName:         ${file_name}
 * @Description:     ${todo}
 * @author:            crane-yuan
 * @version            V1.0
 * Createdate:      ${date}     ${time}
 * Copyright:        Copyright(C) 2016-2017
 * Company           CY.
 * All rights Reserved, Designed By crane-yuan

 * Modification  History:
 * Date         Author        Version        Discription
 * ---------------------------------------------------------------------------
 * ${date}     crane-yuan       1.0             1.0

 * Why & What is modified:

 */

2、類型(Types)注釋標簽（類的注釋）：

/**
 * @ClassName:       ${type_name}
 * @Description:    ${todo}
 * @author:            crane-yuan
 * @date:            ${date}        ${time}
 */

 
3、字段(Fields)注釋標簽：

/**  
  * @Fields ${field} :            ${todo}
  */   

 
4、構造函數(Constructor)注釋標簽：

/**
 * @Title:            ${enclosing_type}
 * @Description:    ${todo}
 * @param:            ${tags}
 * @throws
 */ 

5、方法(Methods)標簽：

/**
 * @Title:             ${enclosing_method}
 * @Description:     ${todo}
 * @param:             ${tags}   
 * @return:         ${return_type}   
 * @throws
 */

 
6、覆蓋方法(Overriding Methods)標簽:

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

 
7、代表方法(Delegate Methods)標簽：

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

8、getter方法標簽：

/**
 * @Title:            ${enclosing_method} <BR>
 * @Description:      ${todo} <BR>
 * @return:         ${field_type} <BR>
 */ 

 
9、setter方法標簽：

/**
 * @Title:          ${enclosing_method} <BR>
 * @Description:     ${todo} <BR>
 * @return:         ${field_type} <BR>
 */