Eclipse Java註釋模板設置詳解

設置註釋模板的入口： 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   
*/

類型(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}
*/

簡單模板例子：

<?xml version="1.0" encoding="UTF-8"?>  
<templates>  
      
    <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="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>  
      
      
    <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">  
    /**  
     * 此方法描述的是：  
     * @author: wangxiongdx@163.com  
     * @version: ${date} ${time}  
     */  
    </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="filecomment_context"   
                deleted="false"   
                description="Comment for created Java files"   
                enabled="true"   
                id="org.eclipse.jdt.ui.text.codetemplates.filecomment"   
                name="filecomment">  
    /**  
     * 文件名：${file_name}  
     *  
     * 版本信息：  
     * 日期：${date}  
     * Copyright 足下 Corporation ${year}   
     * 版權全部  
     *  
     */  
    </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">  
    /**  
     * ${bare_field_name}  
     *  
     * @return  the ${bare_field_name}  
     * @since   CodingExample Ver(編碼範例查看) 1.0  
    */  
    </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">  
    /* (non-Javadoc)  
     * ${see_to_overridden}  
     */  
    </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">  
    /**  
     * ${field}:${todo}（用一句話描述這個變量表示什麼）  
     *  
     * @since Ver 1.1  
     */  
    </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">  
    /**  
     * 此類描述的是：  
     * @author: wangxiongdx@163.com  
     * @version: ${date} ${time}   
     */  
    </template>  
   
 </templates>