Eclipse自動生成所需的各種註釋信息

有個時候寫編碼的時候會用寫一寫註釋之類的 但是有的自動生成的方法又不會自動生成 所以就需要設置了

比如這樣

/**  
 * 員工ID  
 */  
private String userid;   
/**  
 * 獲取員工ID  
 * @return userid 員工ID  
 */  
public String getUserid() {   
    return userid;   
}   
/**  
 * 設置員工ID  
 * @param userid 員工ID  
 */  
public void setUserid(String userid) {   
    this.userid = userid;   
}  
  1. setter getter方法生成註釋

找到Eclipse中Jar包:org.eclipse.jdt.ui_*.jar,進行備份

然後將後綴Jar改爲rar,

找到org.eclipse.jdt.internal.corext.codemanipulation.GetterSetterUtil.class
直接用附件中的class文件進行替換,再將後綴改爲Jar替換Eclipse的Jar包,

重啓Eclipse設置註釋風格:

Window->Preferences->Java CodeStyle->Code Templates->Comments->Getters/Setters

或者項目右鍵properties 查找setter 如上述操作也可以

/**  
 * 獲取${bare_field_name}  
 * @return ${bare_field_name} ${bare_field_name}  
 */  
/**  
 * 設置${bare_field_name}  
 * @param ${bare_field_name} ${bare_field_name}  
 */  

2.附上其他的選項設置

文件(Files)註釋標籤:

/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}(用一句話描述該文件做什麼)
* @author ${user}
* @date ${date}
* @version V1.0
*/

類型(Types)註釋標籤(類的註釋):

/**
* @ClassName: ${type_name}
* @Description: ${todo}(這裏用一句話描述這個類的作用)
* @author ${user}
* @date ${date}
*
* ${tags}
*/

字段(Fields)註釋標籤:

/**
* @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
*/

構造函數(Constructor)標籤:

/**
* 創建一個新的實例 ${enclosing_type}.
*
* ${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 ${bare_field_name}
*/

setter方法標籤:

/**
* @param ${param} the ${bare_field_name} to set
*/

要實現上面的註釋模板,這需要將下面的配置文件導入就可以了:

<?xml version="1.0" encoding="UTF-8"?>
<templates>
    <template
                autoinsert="false"
                context="filecomment_context"
                deleted="false"
                description="Comment for created Java files"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
                name="filecomment">
    /**  
    * @Title: ${file_name}
    * @Package ${package_name}
    * @Description: ${todo}(用一句話描述該文件做什麼)
    * @author ${user}
    * @date ${date}
    * @version V1.0  
    */
    </template>
    <template
                autoinsert="false"
                context="typecomment_context"
                deleted="false"
                description="Comment for created types"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
                name="typecomment">
    /**
    * @ClassName: ${type_name}
    * @Description: ${todo}(這裏用一句話描述這個類的作用)
    * @author ${user}
    * @date ${date}
    *
    * ${tags}
    */
    </template>
    <template
                autoinsert="false"
                context="fieldcomment_context"
                deleted="false"
                description="Comment for fields"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
                name="fieldcomment">
    /**
    * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
    */
    </template>
    <template
                autoinsert="false"
                  context="constructorcomment_context"
                deleted="false"
                description="Comment for created constructors"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
                name="constructorcomment">
    /**
     * 創建一個新的實例 ${enclosing_type}.
     *
     * ${tags}
     */
    </template>
        <template
                autoinsert="false"
                context="methodcomment_context"
                deleted="false"
                description="Comment for non-overriding methods"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
                name="methodcomment">
    /**
    * @Title: ${enclosing_method}
    * @Description: ${todo}(這裏用一句話描述這個方法的作用)
    * @param ${tags}    參數
    * @return ${return_type}    返回類型
    * @throws
    */
    </template>
    <template
                autoinsert="true"
                context="overridecomment_context"
                deleted="false"
                description="Comment for overriding methods"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
                name="overridecomment">
    /* (非 Javadoc)
    * <p>Title: ${enclosing_method}</p>
    * <p>Description: </p>
    * ${tags}
    * ${see_to_overridden}
    */
    </template>
        <template
                autoinsert="true"
                context="delegatecomment_context"
                deleted="false"
                description="Comment for delegate methods"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
                name="delegatecomment">
    /**
     * ${tags}
     * ${see_to_target}
     */
    </template>
    <template
                autoinsert="false"
                context="gettercomment_context"
                deleted="false"
                description="Comment for getter method"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
                name="gettercomment">
    /**
    * @return ${bare_field_name}
    */
    </template>
    <template
                autoinsert="true"
                context="settercomment_context"
                deleted="false"
                description="Comment for setter method"
                enabled="true"
                id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
                name="settercomment">
    /**
     * @param ${param} the ${bare_field_name} to set
     */
    </template>
發佈了49 篇原創文章 · 獲贊 4 · 訪問量 7萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章