windows-&preferences-&java-&Code&Templates-&comments-&Type-&edit&Eclipse注释规范模版总结新建类文件/**&*&@ClassName:&&&&&${file_name}&*&@Description:&&&${todo}(用一句话描述该文件做什么)&&*&&*&@author&&&&&&&&&${user}&*&@version&&&&&&&&V1.0 &&*&@Date&&&&&&&&&&&${date}&${time}&&*/方法/**&&*&@Title:&&&&&&&&${enclosing_method}&&*&@Description:&&${todo}(这里用一句话描述这个方法的作用)&&*&@param:&&&&&&&&${tags} & &&*&@return:&&&&&&&${return_type} & &&*&@throws&&*&@author&&&&&&&&${user}&*&@Date&&&&&&&&&&${date}&${time}&&*/输入设置模板：&/**& & &&*&${file_name}&Create&on&${date} & &&* & & &*&Copyright&(c)&${date}&by&taotaosoft & & &* & & &*&@author&&a&href="xiuzhong.li&#"&Jerryli&/a& & &&*&@version&1.0&* & &&*/&注意选择自动添加注释,养成一个规范的习惯是最好的。&选菜单&windows--&preference&&--&&Java--&Code&Style--&Code&Templates&&--&&code--&new&Java&files&选中点编辑&${filecomment}&${package_declaration}&/**&*&@author&作者姓名&&E-mail:&email地址&*&@version&创建时间：${date}&${time}&*&类说明&*/&${typecomment}&${type_declaration}&&&&Eclipse注释规范模版总结1、&&具体操作(1)在eclipse中，打开Window-&Preference-&Java-&Code&Style-&Code&Template(2)然后展开Comments节点就是所有需设置注释的元素，参照2注释规范对应设置即可2、&&注释规范(1)文件(Files)注释标签/**&*&FileName:&&&&&${file_name}&*&@Description:&${todo}(用一句话描述该文件做什么)*&All&rights&Reserved,&Designed&By&ZTE-ITS&*&Copyright:&&&&Copyright(C)&&*&Company&&&&&&&ZTE-ITS&WuXi&LTD.&*&@author:&&&&名字&*&@version&&&&V1.0&&*&Createdate:&&&&&&&&&${date}&${time}&*&*&Modification&&History:&*&Date&&&&&&&&&Author&&&&&&&&Version&&&&&&&&Discription&*&-----------------------------------------------------------------------------------&*&${date}&&&&&&&wu.zh&&&&&&&&&&1.0&&&&&&&&&&&&&1.0&*&Why&&&What&is&modified:&&修改原因描述&&*/&(2)类型(Types)注释标签(类的注释)：&/**&*&@ClassName:&&&&&${type_name}&*&@Description:${todo}(这里用一句话描述这个类的作用)&*&@author:&&&&Android_Robot&*&@date:&&&&&&&&${date}&${time}&*&*&${tags}&*/&(3)字段(Fields)注释标签：&/**&&&*&@Fields&${field}&:&${todo}(用一句话描述这个变量表示什么) &&&*/&&&&(4)构造函数标签：&/**&*&@Title:&&&&&&&&${enclosing_type}&*&@Description:&&&&${todo}(这里用一句话描述这个方法的作用)&*&@param:&&&&${tags}&*&@throws&*/&(5)方法(Methods)标签：/**&*&@Title:&${enclosing_method}&*&@Description:&${todo}(这里用一句话描述这个方法的作用)&*&@param:&${tags} &&&*&@return:&${return_type} &&&*&@throws&*/&(6)覆盖方法(Overriding&Methods)标签:&/**&*&&p&Title:&${enclosing_method}&/p&&*&&p&Description:&&/p&&*&${tags}&*&${see_to_overridden}&*/&(7)代表方法(Delegate&Methods)标签：/**&*&${tags}&*&${see_to_target}&*/&(8)getter方法标签：/**&*&@Title:&&&&&&&&${enclosing_method}&&BR&&*&@Description:&please&write&your&description&&BR&&*&@return:&&&&&${field_type}&&BR&&*/&(9)setter方法标签：/**&&*&@Title:&&${enclosing_method}&&BR&&&*&@Description:&please&write&your&description&&BR&&&*&@return:&${field_type}&&BR&&&*/&—————ITOO（13）
& & & & &越到后面发现我们的学习逐步职业化，就拿注释来说，良好的注释说明有助于他人对程序的理解和后期的维护，在ITOO中更多的接触都是类里面方法或变量等的注释，前几天验收下期机房合作，发现一个良好的注释风格给人的印象和感受真的不一样。最近自己也在ITOO中重新搭框架，里面需要自己添加很多类，之前在项目中都是把头注释放在工具箱中，使用时候直接拖拽，当然这也是其中之一。这次想到之前自己在机房的时候也用到过一种方法，直接在安装路径中修改新建类的模板。因为类头注释里面的内容多，而且每个类或窗体里面的头注释内容大多相似，所以每次新建一个类或窗体的时候都要复制粘贴（当然还得稍微修改一下）？现在好了可以让VS自动生成头注释。网上也有很多这方面文章，可谓站在巨人肩膀上。
如何设置类头注释模板？
&&1、打开VS2012的安装目录，找到Common7文件夹，接着打开D:\VS\Common7\IDE\ItemTemplates\CSharp\Code\2052\Class，找到Class.cs文件并且以记事本方式打开，在其中加入你想要的模板。
/**********************************************************************************
* 开发人:李立平
* 开发组：王静娜、杨晨光、张子杰
* 类说明：
* 开发时间：$time$
* 开发版本：V4.0.0
**********************************************************************************/
using System.Collections.G
$if$ ($targetframeworkversion$ &= 3.5)using System.L
$endif$using System.T
$if$ ($targetframeworkversion$ &= 4.5)using System.Threading.T
namespace $rootnamespace$
class $safeitemrootname$
2、然后打开VS2012，新建一个类试一下效果：果然，新建类时VS就会自动生成&头文件注释了。
& & & & 当然还有一些接口、WebClass等标头的设置，还有其他语言的设置，磨刀不误砍柴工，工欲善其事必先利其器说的都是这个道理。
参考知识库
* 以上用户言论只代表其个人观点，不代表CSDN网站的观点或立场
访问：99954次
积分：5487
积分：5487
排名：第3750名
原创：124篇
评论：1549条
阅读：9569
文章：11篇
阅读：8983
(3)(1)(3)(4)(3)(8)(4)(2)(4)(4)(6)(4)(1)(1)(4)(3)(2)(5)(5)(3)(3)(3)(1)(7)(3)(1)(1)(5)(3)(8)(3)(4)(2)(1)(4)(1)(3)(1)> Eclipse中创办新类时自动生成注释
Eclipse中创办新类时自动生成注释
jinchengjie & &
发布时间： & &
浏览：3 & &
回复：0 & &
悬赏：0.0希赛币
Eclipse中创建新类时自动生成注释
　　windows--&preferenceJava--&Code Style--&Code Templates--&code--&new Java files
　　编辑它
　　${filecomment}${package_declaration}/*** @author 作者 E-mail:* @version 创建时间：${date} ${time}* 类说明*/${typecomment}${type_declaration}
　　设置注释模板的入口： 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} */
　　简单模板例子： & xml version="1.0" encoding="UTF-8" &&templates&&template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipsdetemplates.fieldcomment" name="fieldcomment"&/**　* @Fields ${field} : ${todo}(用一句话描述这个变量表示什么)　*/　&/template&&template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipsdetemplates.gettercomment" name="gettercomment"&/**　* @return ${bare_field_name}　*/　&/template&&template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipsdetemplates.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.eclipsdetemplates.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.eclipsdetemplates.settercomment" name="settercomment"&/**　* @param ${param} 要设置的 ${bare_field_name}　*/&/template&&template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipsdetemplates.typecomment" name="typecomment"&/**　* @author ${user}　*　* ${tags}　*/&/template&&template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipsdetemplates.delegatecomment" name="delegatecomment"&/**　* ${tags}　* ${see_to_target}　*/&/template&&template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipsdetemplates.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.eclipsdetemplates.methodcomment" name="methodcomment"&/**　* ${tags}　*/&/template&&/templa　& xml version="1.0" encoding="UTF-8" &&templates&&template autoinsert="true" context="fieldcomment_context" deleted="false" description="字段的注释" enabled="true" id="org.eclipsdetemplates.fieldcomment" name="fieldcomment"&/** * @Fields ${field} : ${todo}(用一句话描述这个变量表示什么) */ &/template&&template autoinsert="true" context="gettercomment_context" deleted="false" description="getter 方法的注释" enabled="true" id="org.eclipsdetemplates.gettercomment" name="gettercomment"&/** * @return ${bare_field_name} */ &/template&&template autoinsert="true" context="constructorcomment_context" deleted="false" description="创建的构造函数的注释" enabled="true" id="org.eclipsdetemplates.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.eclipsdetemplates.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.eclipsdetemplates.settercomment" name="settercomment"&/** * @param ${param} 要设置的 ${bare_field_name} */&/template&&template autoinsert="true" context="typecomment_context" deleted="false" description="创建的类型的注释" enabled="true" id="org.eclipsdetemplates.typecomment" name="typecomment"&/** * @author ${user} * * ${tags} */&/template&&template autoinsert="true" context="delegatecomment_context" deleted="false" description="代表方法的注释" enabled="true" id="org.eclipsdetemplates.delegatecomment" name="delegatecomment"&/** * ${tags} * ${see_to_target} */&/template&&template autoinsert="true" context="overridecomment_context" deleted="false" description="覆盖方法的注释" enabled="true" id="org.eclipsdetemplates.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.eclipsdetemplates.methodcomment" name="methodcomment"&/** * ${tags} */&/template&&/templa
　　例子2： & xml version="1.0" encoding="UTF-8" &　&templates&　　
&template　　　　　　　　　
autoinsert="false"　　　　　　　　　
context="constructorcomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for created constructors"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.constructorcomment"　　　　　　　　
name="constructorcomment"&　　
/**　 　　 * 创建一个新的实例 ${enclosing_type}.　 　　 *　 　　 * ${tags}　 　　 */　 　
&/template&　　
&template　　　　　　　　　
autoinsert="true"　　　　　　　　　
context="settercomment_context"　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for setter method"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.settercomment"　　　　　　　　　
name="settercomment"&　　
/**　 　　 * @param ${param} the ${bare_field_name} to set　 　　 */　 　
&/template&　　
&template　　　　　　　　
autoinsert="false"　　　　　　　　　
context="methodcomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for non-overriding methods"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.methodcomment"　　　　　　　　　
name="methodcomment"&　　
/**　 　　 * 此方法描述的是：　 　　 * @author: 　 　　 * @version: ${date} ${time}　 　　 */　 　
&/template&　　
&template　　　　　　　　　
autoinsert="true"　　　　　　　　　
context="delegatecomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for delegate methods"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.delegatecomment"　　　　　　　　　
name="delegatecomment"&　　
/**　 　　 * ${tags}　 　　 * ${see_to_target}　 　　 */　 　
&/template&　　
&template　　　　　　　　
autoinsert="false"　　　　　　　　　
context="filecomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for created Java files"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.filecomment"　　　　　　　　　
name="filecomment"&　　
/**　 　　 * 文件名：${file_name}　 　　 *　 　　 * 版本信息：　 　　 * 日期：${date}　 　　 * Copyright 足下 Corporation ${year}　　　　 * 版权所有　 　　 *　 　　 */　 　
&/template&　　
&template　　　　　　　　　
autoinsert="false"　　　　　　　　　
context="gettercomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for getter method"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.gettercomment"　　　　　　　　　
name="gettercomment"&　　
/**　 　　 * ${bare_field_name}　 　　 *　 　　 * @return
the ${bare_field_name}　 　　 * @since　 CodingExample Ver(编码范例查看) 1.0　 　
&/template&　　
&template　　　　　　　　　
autoinsert="true"　　　　　　　　　
context="overridecomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for overriding methods"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.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.eclipsdetemplates.fieldcomment"　　　　　　　　　
name="fieldcomment"&　　
/**　 　　 * ${field}:${todo}（用一句话描述这个变量表示什么）　 　　 *　 　　 * @since Ver 1.1　 　　 */　 　
&/template&　　
&template　　　　　　　　　
autoinsert="false"　　　　　　　　　
context="typecomment_context"　　　　　　　　　
deleted="false"　　　　　　　　　
description="Comment for created types"　　　　　　　　　
enabled="true"　　　　　　　　　
id="org.eclipsdetemplates.typecomment"　　　　　　　　　
name="typecomment"&　　
/**　 　　 * 此类描述的是：　 　　 * @author: 　 　　 * @version: ${date} ${time}　　　　 */　 　
&/template&　&/templates&　& xml version="1.0" encoding="UTF-8" & &templates& 　
&template 　　　　　　　
autoinsert="false" 　　　　　　　　
context="constructorcomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for created constructors" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.constructorcomment" 　　　　　　　
name="constructorcomment"& 　
/** 　　 * 创建一个新的实例 ${enclosing_type}. 　　 * 　　 * ${tags} 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="true" 　　　　　　　
context="settercomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for setter method" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.settercomment" 　　　　　　　
name="settercomment"& 　
/** 　　 * @param ${param} the ${bare_field_name} to set 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="false" 　　　　　　　
context="methodcomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for non-overriding methods" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.methodcomment" 　　　　　　　
name="methodcomment"& 　
/** 　　 * 此方法描述的是： 　　 * @author:
　　 * @version: ${date} ${time} 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="true" 　　　　　　　
context="delegatecomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for delegate methods" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.delegatecomment" 　　　　　　　
name="delegatecomment"& 　
/** 　　 * ${tags} 　　 * ${see_to_target} 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="false" 　　　　　　　
context="filecomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for created Java files" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.filecomment" 　　　　　　　
name="filecomment"& 　
/** 　　 * 文件名：${file_name} 　　 * 　　 * 版本信息： 　　 * 日期：${date} 　　 * Copyright 足下 Corporation ${year} 　　 * 版权所有 　　 * 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="false" 　　　　　　　
context="gettercomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for getter method" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.gettercomment" 　　　　　　　
name="gettercomment"& 　
/** 　　 * ${bare_field_name} 　　 * 　　 * @return
the ${bare_field_name} 　　 * @since　 CodingExample Ver(编码范例查看) 1.0 　
&/template&
　　&template 　　　　　　　
autoinsert="true" 　　　　　　　
context="overridecomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for overriding methods" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.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.eclipsdetemplates.fieldcomment" 　　　　　　　
name="fieldcomment"& 　
/** 　　 * ${field}:${todo}（用一句话描述这个变量表示什么） 　　 * 　　 * @since Ver 1.1 　　 */ 　
&/template& 　
&template 　　　　　　　
autoinsert="false" 　　　　　　　
context="typecomment_context" 　　　　　　　
deleted="false" 　　　　　　　
description="Comment for created types" 　　　　　　　
enabled="true" 　　　　　　　
id="org.eclipsdetemplates.typecomment" 　　　　　　　
name="typecomment"& 　
/** 　　 * 此类描述的是： 　　 * @author:
　　 * @version: ${date} ${time} 　　 */ 　
&/template& &/templates&
本问题标题：
本问题地址：
温馨提示：本问答中心的任何言论仅代表发言者个人的观点，与希赛网立场无关。请对您的言论负责，遵守中华人民共和国有关法律、法规。如果您的言论违反希赛网问答中心的规则，将会被删除。
暂无合适的专家
&&&&&&&&&&&&&&&
希赛网 版权所有 & &&Eclipse 自动生成类的注释 - ITeye问答
新建一个类，怎么自动生成类的注释，默认情况下 generate comments 没有勾选上，怎么设置 默认才会勾选上
问题补充：zydeng 写道Window-&Preferences-&Java-&Code Style-&Code Templates
在这个界面有个CheckBox [ Automatically add comments for new methods and types ]，勾选它就可以了。
同时你还可以修改注释模板。
Window-&Preferences-&Java-&Code Style 这个里面
采纳的答案
Window-&Preferences-&Java-&Code Style-&Code Templates
在这个界面有个CheckBox [ Automatically add comments for new methods and types ]，勾选它就可以了。
同时你还可以修改注释模板。
已解决问题
未解决问题