使用Eclipse设置Java注释模板详解

<iframe id="cproIframe_u2113990_1" width="468" height="60" src="http://pos.baidu.com/acom?adn=2&at=231&aurl=&cad=1&ccd=24&cec=UTF-8&cfv=17&ch=0&col=zh-CN&conBW=0&conOP=1&cpa=1&dai=1&dis=0&layout_filter=image&ltr=http%3A%2F%2Fwww.hpboys.com%2F&ltu=http%3A%2F%2Fwww.hpboys.com%2F720.html&lu_161=0&lunum=6&n=36082130_cpr&pcs=1907x955&pis=10000x10000&ps=280x443&psr=1920x1080&pss=1907x1219&qn=61d4eada20466a51&rad=&rsi0=468&rsi1=60&rsi5=4&rss0=%23FFFFFF&rss1=%23FFFFFF&rss2=%230000ff&rss3=%23444444&rss4=%23008000&rss5=&rss6=%23e10900&rss7=&scale=&skin=tabcloud_skin_3&stid=5&td_id=2113990&titFF=%E5%AE%8B%E4%BD%93&titFS=12&titTA=left&tn=text_default_468_60&tpr=1432203543681&ts=1&version=2.0&xuanting=0&dtm=BAIDU_DUP2_SETJSONADSLOT&dc=2&di=u2113990&ti=%E4%BD%BF%E7%94%A8Eclipse%E8%AE%BE%E7%BD%AEJava%E6%B3%A8%E9%87%8A%E6%A8%A1%E6%9D%BF%E8%AF%A6%E8%A7%A3%20%7C%20%E7%A0%B4%E6%99%93%E5%8D%9A%E5%AE%A2&tt=1432203543664.18.84.86" align="center,center" marginwidth="0" marginheight="0" scrolling="no" frameborder="0" allowtransparency="true" style="margin: 0px; padding: 0px; border-width: 0px; outline: 0px; vertical-align: baseline; font-style: inherit; max-width: 100%; font-family: inherit; font-weight: inherit; background: transparent;"></iframe>

设置注释模板的入口： Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素啦。现就每一个元素逐一介绍：

文件(Files)注释标签：

/**   

* @Title: ${file_name}

* @Package ${package_name}

* @Description: ${todo}(用一句话描述该文件做什么)

* @author A18ccms A18ccms_gmail_com   

* @date ${date} ${time}

* @version V1.0   

*/

类型(Types)注释标签（类的注释）：

/**

* @ClassName: ${type_name}

* @Description: ${todo}(这里用一句话描述这个类的作用)

* @author A18ccms a18ccms_gmail_com

* @date ${date} ${time}

* 

* ${tags}

*/

字段(Fields)注释标签：

/**

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)

*/

构造函数标签：

/**

* <p>Title: </p>

* <p>Description: </p>

* ${tags}

*/

方法(Constructor & 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 ${param} 要设置的 ${bare_field_name}

*/

 简单模板例子：

例子1：

<?xml version="1.0" encoding="UTF-8"?><templates><template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**
  

* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)   

*/   

</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**
  

 * @return ${bare_field_name}   

 */   

 </template><template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**
  

* <p>Title:${file_name} </p>  

* <p>Description: 构造函数</p>  

* ${tags}   

*/   

</template><template autoinsert="true" context="filecomment_context" deleted="false" description="已创建的 Java 文件的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">/**  
  

* @Title: ${file_name}   

* @Package ${package_name}   

* @Description: ${todo}(用一句话描述该文件做什么)   

* @author DAIGUANGJIU      

* @date ${date} ${time}   

* @version V1.0     

*/   

 </template><template autoinsert="true" context="settercomment_context" deleted="false" description="setter 方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">/**
  

 * @param ${param} 要设置的 ${bare_field_name}   

 */</template><template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">/**
  

 * @author ${user}   

 *   

 * ${tags}   

 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment" name="delegatecomment">/**
  

* ${tags}   

* ${see_to_target}   

*/</template><template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" 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="methodcomment_context" deleted="false" description="非覆盖方法的注释" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**
  

 * ${tags}   

 */</template></templa  

例子2：

/**

* 创建一个新的实例 ${enclosing_type}.

*

* ${tags}

*//**

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

*//**

* 此方法描述的是：

* @author: wangxiongdx@163.com

* @version: ${date} ${time}

*//**

* ${tags}

* ${see_to_target}

*//**

* 文件名：${file_name}

*

* 版本信息：

* 日期：${date}

* Copyright 足下 Corporation ${year}

* 版权所有

*

*//**

* ${bare_field_name}

*

* @return the ${bare_field_name}

* @since CodingExample Ver(编码范例查看) 1.0

*//* (non-Javadoc)

* ${see_to_overridden}

*//**

* ${field}:${todo}（用一句话描述这个变量表示什么）

*

* @since Ver 1.1

*//**

* 此类描述的是：

* @author: wangxiongdx@163.com

* @version: ${date} ${time}

*/

原文地址: http://www.hpboys.com/720.html