更新時間:2022-01-18 10:52:13 來源:動力節點 瀏覽1121次
設置注釋模板的:Window --> Preference --> Java->Code Style --> Code Template
然后展開Comments節點就是所有需設置注釋的元素。本文現就每一個元素逐一給大家介紹一下。
文件(Files)注釋標簽:
/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo}(用一句話描述該文件做什么) * @author ${user} * @date ${date} * @version V1.0 */
類型(Types)注釋標簽(類的注釋):
/** * @ClassName: ${type_name} * @Description: ${todo}(這里用一句話描述這個類的作用) * @author ${user} * @date ${date} * * ${tags} */
字段(Fields)注釋標簽:
/** * @Fields field:field:{todo}(用一句話描述這個變量表示什么) */
構造函數(Constructor)標簽:
/** * 創建一個新的實例 ${enclosing_type} * * ${tags} */
方法(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 paramtheparamthe{bare_field_name} to set */
隨便選擇一個,下方【Pattern】區域會顯示類注釋模板內容,點擊右則的【Edit】按鈕可以對注釋模板內容進行修改。
選擇【Insert Variable】可以對【Pattern】中的【Title】值進行設置修改。
如果都想要實現上面的注釋模板,逐個改可能很麻煩,這需要將下面的配置文件導入就可以了:
新建一個xml文件,名字命名為codetemplates(名字可以隨便命名)
把下面的內容放到xml文件中即可。
<?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} ${time} * @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: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"> /** * 創建一個新的實例 ${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} 參數 * @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 paramtheparamthe{bare_field_name} to set */ </template></templates>
0基礎 0學費 15天面授
有基礎 直達就業
業余時間 高薪轉行
工作1~3年,加薪神器
工作3~5年,晉升架構
提交申請后,顧問老師會電話與您溝通安排學習