1. 程式人生 > >Eclipse Java註釋模板設定詳解

Eclipse Java註釋模板設定詳解

出於對作者的尊重和感謝,原文地址為http://blog.csdn.net/ahhsxy/article/details/4542682

設定註釋模板的入口: 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}
*/

簡單模板例子:

[java] view plain copy  print?
  1. <?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="欄位的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/** 
  2. * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼) 
  3. */
  4. </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/** 
  5.  * @return ${bare_field_name} 
  6.  */
  7.  </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="建立的建構函式的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/** 
  8. * <p>Title:${file_name} </p> 
  9. * <p>Description: 建構函式</p> 
  10. * ${tags} 
  11. */
  12. </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已建立的 Java 檔案的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**   
  13. * @Title: ${file_name} 
  14. * @Package ${package_name} 
  15. * @Description: ${todo}(用一句話描述該檔案做什麼) 
  16. * @author DAIGUANGJIU    
  17. * @date ${date} ${time} 
  18. * @version V1.0   
  19. */
  20.  </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** 
  21.  * @param ${param} 要設定的 ${bare_field_name} 
  22.  */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="建立的型別的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** 
  23.  * @author ${user} 
  24.  * 
  25.  * ${tags} 
  26.  */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/** 
  27. * ${tags} 
  28. * ${see_to_target} 
  29. */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/** (非 Javadoc) 
  30. * <p>Title: ${enclosing_method}</p> 
  31. * <p>Description: </p> 
  32. * ${tags} 
  33. * ${see_to_overridden} 
  34. */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/** 
  35.  * ${tags} 
  36.  */</template></templa  

例子2:

[xhtml] view plain copy  print?
  1. <?xmlversion="1.0"encoding="UTF-8"?>
  2. <templates>
  3.     <template
  4.                 autoinsert="false"
  5.                 context="constructorcomment_context"
  6.                 deleted="false"
  7.                 description="Comment for created constructors"
  8.                 enabled="true"
  9.                 id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
  10.                 name="constructorcomment">
  11.     /**  
  12.      * 建立一個新的例項 ${enclosing_type}.  
  13.      *  
  14.      * ${tags}  
  15.      */  
  16.     </template>
  17.     <template
  18.                 autoinsert="true"
  19.                 context="settercomment_context"
  20.                 deleted="false"
  21.                 description="Comment for setter method"
  22.                 enabled="true"
  23.                 id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
  24.                 name="settercomment">
  25.     /**  
  26.      * @param ${param} the ${bare_field_name} to set  
  27.      */  
  28.     </template>
  29.     <template
  30.                 autoinsert="false"
  31.                 context="methodcomment_context"
  32.                 deleted="false"
  33.                 description="Comment for non-overriding methods"
  34.                 enabled="true"
  35.                 id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
  36.                 name="methodcomment">
  37.     /**  
  38.      * 此方法描述的是:  
  39.      * @author: [email protected]  
  40.      * @version: ${date} ${time}  
  41.      */  
  42.     </template>
  43.     <template
  44.                 autoinsert="true"
  45.                 context="delegatecomment_context"
  46.                 deleted="false"
  47.                 description="Comment for delegate methods"
  48.                 enabled="true"
  49.                 id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
  50.                 name="delegatecomment">
  51.     /**  
  52.      * ${tags}  
  53.      * ${see_to_target}  
  54.      */  
  55.     </template>
  56.     <template
  57.                 autoinsert="false"
  58.                 context="filecomment_context"
  59.                 deleted="false"
  60.                 description="Comment for created Java files"
  61.                 enabled="true"
  62.                 id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
  63.                 name="filecomment">
  64.     /**  
  65.      * 檔名:${file_name}  
  66.      *  
  67.      * 版本資訊:  
  68.      * 日期:${date}