Eclipse中設定作者日期等Java注釋模闆詳解

Eclipse作為一種內建開發環境（Integrated Development Environment）,可以通過設定自動添加Javadoc注釋資訊來進行辨別。

常用的注釋

首先來認識幾個常用的注解：

• @author 作者名
• @date 日期
• @version 版本辨別
• @parameter 參數及其意義
• @return 傳回值
• @throws 異常類及抛出條件
• @deprecated 引起不推薦使用的警告
• @override 重寫

IDE中入口

注釋模闆的入口：Window->Preference->Java->Code Style->Code Template

 設定對應模闆（建議）

隻是個建議，自己可以根據需求自行修改

類型(Types)注釋标簽（類的注釋）：

/**
* @ClassName: ${type_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
* ${tags}
*/

檔案(Files)注釋标簽：


/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo}
* @author ${user}
* @date ${date}
* @version V1.0
*/

字段(Fields)注釋标簽：

/**
* @Fields field:field:{todo}
*/

構造函數(Constructor)标簽：

/**
* 建立新執行個體 ${enclosing_type}.
* ${tags}
*/

方法(Methods)标簽：

/**
* @Title: ${enclosing_method}
* @Description: ${todo}
* @param ${tags} 
* @return ${return_type}
* @throws
*/

覆寫方法(Overriding Methods)标簽：

/**
* Title: ${enclosing_method}
* @Description: ${todo}
* ${tags}
* ${see_to_overridden}
*/

代表方法(Delegate Methods)标簽：

/**
* ${tags}
* ${see_to_target}
*/

getter方法标簽：

/**
* @return ${bare_field_name}
*/

setter方法标簽：

/**
* @param ${param} the ${bare_field_name} to set
*/

           

 導入與導出

也可以複制以下配置，直接導入就可以了，建立檔案“codetemplates.xml”

<?xml version="1.0" encoding="UTF-8"?>
<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>
<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="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">
/**
* Title: ${enclosing_method}
* @Description: ${todo}
* ${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>