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?- <?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">/**
- * @Fields ${field} : ${todo}(用一句話描述這個變量表示什麼)
- */
- </template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
- * @return ${bare_field_name}
- */
- </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="建立的建構函式的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
- * <p>Title:${file_name} </p>
- * <p>Description: 建構函式</p>
- * ${tags}
- */
- </template><template autoinsert="true" context="filecomment_context" deleted="false" description="已建立的 Java 檔案的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**
- * @Title: ${file_name}
- * @Package ${package_name}
- * @Description: ${todo}(用一句話描述該檔案做什麼)
- * @author DAIGUANGJIU
- * @date ${date} ${time}
- * @version V1.0
- */
- </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
- * @param ${param} 要設定的 ${bare_field_name}
- */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="建立的型別的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
- * @author ${user}
- *
- * ${tags}
- */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
- * ${tags}
- * ${see_to_target}
- */</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的註釋" 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="methodcomment_context" deleted="false" description="非覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
- * ${tags}
- */</template></templa
例子2:
[xhtml] view plain copy print?- <?xmlversion="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: [email protected]
- * @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}