摘要:設(shè)置注釋模板的入口:Window->Preference->Java->Code Style->Code Template 然后展開Comments節(jié)點就是所有需設(shè)置注釋的元素。本文現(xiàn)就每一個元素逐一給大家介紹一下。文件(Files)注釋標(biāo)簽:/** * @Title: ${file_name} * @Package ${packag
設(shè)置注釋模板的入口:Window->Preference->Java->Code Style->Code Template 然后展開Comments節(jié)點就是所有需設(shè)置注釋的元素。本文現(xiàn)就每一個元素逐一給大家介紹一下。
文件(Files)注釋標(biāo)簽:
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件做什么) * @author ${user} * @date ${date} * @version V1.0 */
類型(Types)注釋標(biāo)簽(類的注釋):
/** * @ClassName: ${type_name} * @Description: ${todo}(這里用一句話描述這個類的作用) * @author ${user} * @date ${date} * * ${tags} */
字段(Fields)注釋標(biāo)簽:
/** * @Fields ${field} : ${todo}(用一句話描述這個變量表示什么) */
構(gòu)造函數(shù)(Constructor)標(biāo)簽:
/** * 創(chuàng)建一個新的實例 ${enclosing_type}. * * ${tags} */
方法(Methods)標(biāo)簽:
/** * @Title: ${enclosing_method} * @Description: ${todo}(這里用一句話描述這個方法的作用) * @param ${tags} 參數(shù) * @return ${return_type} 返回類型 * @throws */
覆蓋方法(Overriding Methods)標(biāo)簽:
/* (非 Javadoc) * <p>Title: ${enclosing_method}</p>* <p>Description: </p>* ${tags} * ${see_to_overridden} */
代理方法(Delegate Methods)標(biāo)簽:
/** * ${tags} * ${see_to_target} */
getter方法標(biāo)簽:
/** * @return ${bare_field_name} */
setter方法標(biāo)簽:
/** * @param ${param} the ${bare_field_name} to set */
要實現(xiàn)上面的注釋模板,這需要將下面的配置文件導(dǎo)入就可以了:
<?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"> /** * 創(chuàng)建一個新的實例 ${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} 參數(shù) * @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> </templates>