咱們在寫一個類時,常常會給這個類作註釋,但是一個項目中可能有不少類,怎麼樣才能讓它本身生成註釋呢?下面,就讓我把本身使用的方法寫出來,以便之後的查找和翻閱。首先聲明的是,我用的是mac本,eclipse也是適用於mac的。這裏介紹兩種方法。 php
第一種方法具體操做步驟以下: java
(1)首先選中一個eclipse中的項目。由於在eclipse中,咱們可能安裝了不少插件,以即可以支持java,android,c,c++及php等,每一種語言的屬性多是不一樣的,因此,若是你的項目中安裝了兩種以上語言的插件,請先選中一個項目。由於我是作android的開發的,因此,我選中一個android的項目,以此爲例來記錄eclipse中註釋的設置; android
(2)依次點擊:Project—>Properties—>Java Code Style—>Code Templates; c++
(3)在「Enable project specific settings」前面打上對勾; app
(4)接着依次點擊:Comments—>Types—>Edit; eclipse
(5)在彈出的窗口中填上以下代碼: ide
/** ui
* spa
*項目名稱:${project_name} 插件
*類名稱:${type_name}
*類描述:
*建立人:${user}
*建立時間:${date} ${time}
*
*/
(6)在「Automatically add comments for new methods and types」前打上對勾。這步很重要,若是不打的話,就不能在建立類的時候自動添加註釋。
(7)最後點擊「apply」,「ok」,完成。
第二種方法:
創建一個codetemplates.xml文件,內容爲
<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/** * @param ${param} : set the property ${bare_field_name}. */</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">/** * @title ${file_name} * @package ${package_name} * @description 用一句話描述該文件作什麼 * @author zdq * @update ${date} ${time} * @version V1.0 */</template><template autoinsert="false" 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="typecomment_context" deleted="false" description="Comment for created types" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/** * @description 這裏用一句話描述這個類的做用 * @version 1.0 * @author zdq * @update ${date} ${time} */
</template><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Javadoc) * ${see_to_overridden} */</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} */ </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">/** * ${tags} * @description 用一句話說明這個方法作什麼 * @version 1.0 * @author zdq * @update ${date} ${time} */</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} : return the property ${bare_field_name}. */</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">/** * 類的構造方法 * ${tags} */</template></templates>
在Project—>Properties—>Java Code Style—>Code Templates下的Code Comments中import該文件便可。