Myeclipse(eclipse)中自動注釋格式設定

    在類eclipse的IDE中,我們經常要使用到注釋,是以預設自動注釋格式,給了我們很大的幫助,但是預設的格式中描述過于簡單,我們使用不便,本是将充分介紹自動注釋的使用,并附上通用的格式檔案,看客可以進行自我修改,以便符合自己的使用要求!

  接下來我們就詳細介紹設定的過程:

注釋格式及設定步驟方式: 

 Window -> Preferences -> Java -> Code Style -> Code Templates -> Comment中有許多的自動格式執行個體,我們需要通過這些執行個體來達到一個符合自己要求的注釋

例如我們希望在一個Java檔案的開頭設定作者作者資訊以及日期資訊。

            選擇Types，點選Edit，将

将${user}删除，改成hanyankai，這樣作者資訊就變成hanyankai；點選Insert Variable，選擇Date，這樣就會自動生成日期資訊。

      設定完以後我們測試一下，自動生成的注釋資訊為：

     同樣的步驟，我們也可以對其他例如構造函數等等注釋資訊進行編輯設定。

    使用時滑鼠放置在需要添加注釋的方法内部的任意位置。點選菜單欄中【源代碼】下的【添加Javadoc注釋】，或者使用快捷鍵Alt Shift J，則eclipse自動在該方法前面添加注釋。

注釋的規範如下：

檔案注釋标簽：

類型注釋标簽（類的注釋）：

字段注釋标簽：

構造函數标簽：

方法标簽：

覆寫方法标簽：

代表方法标簽：

getter方法标簽：

setter方法标簽：

附上通用的自動注釋格式檔案,大家可以通過  Window -> Preferences -> Java -> Code Style -> Code Templates -> Comment ->import中進行導入(檔案格式是XML,記得儲存需要使用UTF-8格式)

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates>
	<template autoinsert="true" context="gettercomment_context"
		deleted="false" description="Comment for getter method" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
		* @return the ${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>
	<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">/**
		* <p>Title: </p>
		* <p>Description: </p>
		* ${tags}
		*/
	</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: ${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">/**
		* @author: ${user}
		* @Description: TODO
		* @date: ${date} ${time}
		* ${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="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}
		* ${tags}
		* @throws:
		*/
	</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">/**
		* <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="true" context="newtype_context" deleted="false"
		description="Newly created files" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.newtype" name="newtype">${filecomment}
		${package_declaration}

		${typecomment}
		${type_declaration}
	</template>
	<template autoinsert="true" context="classbody_context"
		deleted="false" description="Code in new class type bodies" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.classbody" name="classbody">
	</template>
	<template autoinsert="true" context="interfacebody_context"
		deleted="false" description="Code in new interface type bodies"
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.interfacebody"
		name="interfacebody">
	</template>
	<template autoinsert="true" context="enumbody_context"
		deleted="false" description="Code in new enum type bodies" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.enumbody" name="enumbody">
	</template>
	<template autoinsert="true" context="annotationbody_context"
		deleted="false" description="Code in new annotation type bodies"
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.annotationbody"
		name="annotationbody">
	</template>
	<template autoinsert="true" context="catchblock_context"
		deleted="false" description="Code in new catch blocks" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.catchblock" name="catchblock">// ${todo}
		Auto-generated catch block
		${exception_var}.printStackTrace();
	</template>
	<template autoinsert="true" context="methodbody_context"
		deleted="false" description="Code in created method stubs" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.methodbody" name="methodbody">// ${todo}
		Auto-generated method stub
		${body_statement}
	</template>
	<template autoinsert="true" context="constructorbody_context"
		deleted="false" description="Code in created constructor stubs"
		enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorbody"
		name="constructorbody">${body_statement}
		// ${todo} Auto-generated constructor stub
	</template>
	<template autoinsert="true" context="getterbody_context"
		deleted="false" description="Code in created getters" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.getterbody" name="getterbody">return
		${field};</template>
	<template autoinsert="true" context="setterbody_context"
		deleted="false" description="Code in created setters" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.setterbody" name="setterbody">${field} =
		${param};</template>
</templates>