在Eclipse下面使用註釋模板自動生成說明
阿新 • • 發佈:2019-01-09
<?xml version="1.0" encoding="UTF-8"?> <templates> <template autoinsert="true" context="filecomment_context" deleted="false" description="已建立的 Java 檔案的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment"> /** * @Project ${project_name} * @File ${file_name} * @Package ${package_name} * @Version V1.0 * @Date ${date} ${time} * @Author 張三 * Copyright (c) All Rights Reserved, ${year}. */ </template> <template autoinsert="true" context="typecomment_context" deleted="false" description="建立的型別的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment"> /** * @Description ${todo} * @ClassName ${type_name} * @Date ${date} ${time} * @Author 張三 * Copyright (c) All Rights Reserved, ${year}. */ </template> <template autoinsert="true" context="fieldcomment_context" deleted="false" description="欄位的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * @Fields ${field} ${todo} */ </template> <template autoinsert="true" context="methodcomment_context" deleted="false" description="非覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * @param ${tags} 引數 * @return ${return_type} 返回型別 * @throws */ </template> <template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * ${tags} * ${see_to_target} */ </template> <template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * @return ${bare_field_name} */ </template> <template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * @param ${param} ${bare_field_name} */ </template> <template autoinsert="true" context="overridecomment_context" deleted="false" description="覆蓋方法的註釋" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment"> /** * @Description ${todo} * @Author 張三 * @Date ${date} ${time} * @param ${tags} 引數 * @return ${return_type} 返回型別 * @throws */ </template> </templates>
第一種:檔案匯入
使用方式:Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素
第二種:直接找到相應的JAVA / JSP /JS等檔案進行手動敲上備註。
使用方式:Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素
如:
/**
* @Project${project_name}
* @File${file_name}
* @Package${package_name}
* @VersionV1.0
* @Date${date} ${time}
* @Author張三
* Copyright (c) All Rights Reserved, ${year}.
*/