如何在Eclipse中自动添加注释和自定义注释风格

如题所述

操作步骤:打开Window->Preferences->Java->Code Style->Code Templates

如图:

点击“Import”,导入模板codetemplates.xml文件。

 

附:codetemplates.xml文件内容

<?xml version="1.0" encoding="UTF-8" standalone="no"?><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">/**

 * <b>项目名:</b>系统项目名称<br/>

 * <b>包名:</b>${package_name}<br/>

 * <b>文件名:</b>${file_name}<br/>

 * <b>版本信息:</b><br/>

 * <b>日期:</b>${date}-${time}<br/>

 * <b>Copyright (c)</b> ${year}XX公司-版权所有<br/>

 *

 */</template><template autoinsert="true" context="filecomment_context" deleted="false" description="Comment for created JavaScript files" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.filecomment" name="filecomment">/**

 *

 */</template><template autoinsert="true" context="delegatecomment_context" deleted="false" description="Comment for delegate functions" enabled="true" id="org.eclipse.wst.jsdt.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.wst.jsdt.ui.text.codetemplates.typecomment" name="typecomment">/**

 * @author kin

 *

 * ${tags}

 */</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">/**

 *

 * <b>类名称:</b>${type_name}<br/>

 * <b>类描述:</b><br/>

 * <b>创建人:</b>kin<br/>

 * <b>修改人:</b>kin<br/>

 * <b>修改时间:</b>${date} ${time}<br/>

 * <b>修改备注:</b><br/>

 * @version 1.0.0<br/>

 *

 */</template><template autoinsert="true" context="fieldcomment_context" deleted="false" description="Comment for vars" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.fieldcomment" name="fieldcomment">/**

 *

 */</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="true" context="overridecomment_context" deleted="false" description="Comment for overriding functions" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.overridecomment" name="overridecomment">/* (non-Jsdoc)

 * ${see_to_overridden}

 */</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="true" context="settercomment_context" deleted="false" description="Comment for setter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.settercomment" name="settercomment">/**

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

 */</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">/**

 * ${bare_field_name}

 *

 * @return  the ${bare_field_name}

 * @since   1.0.0

*/

</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">/**

 * ${enclosing_method}(这里用一句话描述这个方法的作用)<br/>

 * (这里描述这个方法适用条件 – 可选)<br/>

 * ${tags}

 *${return_type}

 * @exception

 * @since  1.0.0

*/</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="constructorcomment_context" deleted="false" description="Comment for created constructors" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">/**

 * ${tags}

 */</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">/* (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">/**

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

 *

 * @since 1.0.0

 */

</template><template autoinsert="true" context="gettercomment_context" deleted="false" description="Comment for getter function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.gettercomment" name="gettercomment">/**

 * @return the ${bare_field_name}

 */</template><template autoinsert="true" context="methodcomment_context" deleted="false" description="Comment for non-overriding function" enabled="true" id="org.eclipse.wst.jsdt.ui.text.codetemplates.methodcomment" name="methodcomment">/**

 * ${tags}

 */</template></templates>

   

温馨提示:内容为网友见解,仅供参考
第1个回答  2018-08-04
可通过如下三种方法自动添加注释: (1)输入“/**”并回车。 (2)用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。 (3)在右键菜单中选择“Source > Generate ElementComment”。
第2个回答  2016-03-22
分两种情况的:
如果是javadoc的注释:可以通过 alt+shift+ j
如果是 lisence:可以同个 code template实现
自定义注释风格
Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> CodeTemplates可以看到Comments下面一系列可以注释的Java代码组成部分(对文件、变量、方法、构造方法、重载函数等等),比如我想定制Java文件的注释风格,那么在右侧选择Comments中的File项,点击Edit,进入编辑模式,这样就可以自定义注释了。其中可以插入一些变量,如日期、文件名、作者等等。本回答被提问者和网友采纳
第3个回答  2018-07-06

  分两种情况的:

    如果是javadoc的注释:可以通过 alt+shift+ j

    如果是 lisence:可以同个 code template实现

  自定义注释风格

    Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> CodeTemplates

    可以看到Comments下面一系列可以注释的Java代码组成部分(对文件、变量、方法、构造方法、重载函数等等),比如我想定制Java文件的注释风格,那么在右侧选择Comments中的File项,点击Edit,进入编辑模式,这样就可以自定义注释了。其中可以插入一些变量,如日期、文件名、作者等等。 

如何在Eclipse中如何自动添加注释和自定义注释风格
1、Formatter设置 Eclipse工具栏上选择Window -> Preferences -> Java -> Code Style -> Formatter,进入如下界面:2、代码自动格式化配置。点击“Edit...”按钮,进入如下Formatter配置界面:上面红色框标记的选项卡中,是所有可以配置的选项。下面对每个选项卡大致可以设置的内容进行简单介绍:Indentation缩...

eclipse中怎么自定义注释
首先,打开Eclipse菜单,选择"Window" > "Preferences" 或者 "General" > "Checkstyle",进入配置界面。在这里,你可以管理Eclipse的内置检查规则,或者创建新的检查配置以满足特定的注释风格需求。如果你需要自定义检查,点击"New..."按钮,选择"Check Configuration",这时你可以选择两种类型:Internal Confi...

如何在Eclipse中如何自动添加注释和自定义注释风格
(1)输入“\/**”并回车。(2)用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。(3)在右键菜单中选择“Source > Generate ElementComment”。2. 如何自定义注释风格 自带的注释格式你不一定喜欢或不符合你公司的标准,那么可以通过下面方法进行修改。(1)Window->Preference 打开参数设置...

eclipse中怎么自定义注释
1. 打开Eclipse,点击“Window”菜单,选择“Preferences”选项。2. 在打开的对话框中,选择“Java”或你希望自定义注释的语言节点。3. 在相应语言的节点下,找到并点击“Code Style”->“Comments”选项。4. 在这里你可以看到不同的注释类型,如“TODO”注释、Javadoc注释等。选择你想要自定义的注释类...

eclipse中怎么自定义注释
在Eclipse中自动添加注释和自定义注释风格的方法:1、Eclipse菜单栏上选择 Window -> Preferences -> Checkstyle,进入如下设置界面:2、在Global Check Configurations框中,列出可以选择的检查配置(Check Configuration),Default栏标记为对勾的默认配置。如果想自己配置检查选择,可以点击“New...”按钮新建...

Eclipse中如何自动添加注释
方法一:Eclipse中设置在创建新类时自动生成注释 windows--preference   Java--Code Style--Code Templates   code--new Java files   编辑它 {filecomment}   ${package_declaration}   \/   * @author 作者 E-mail:&#...

如何在Eclipse中如何自动添加注释和自定义注
设置注释模板的入口:Window->Preference->Java->Code Style->Code Template ,然后展开Comments节点就是所有需设置注释的元素了!如何自动添加注释 可通过如下三种方法自动添加注释: (1)输入“\/**”并回车。 (2)用快捷键 Alt+Shift+J(先选中某个方法、类名或变量名)。 (3)在右键菜单中选择...

如何在eclipse 中设置自动添加Javadoc注释
Eclipse 方法如下:通过菜单 Window->Preference 打开参数设置面板,然后选择:Java -> Code Style -> Code Templates 在右侧选择Comments,将其中的Files项,然后选右边的"Edit",进入编辑模式:进入编辑模式后就可以自定义注释了。另外可以插入一些变量,如年、日期等等。最后,确保 Code -> New Java...

如何在eclipse 中设置自动添加Javadoc注释
方法如下:打开eclipse,打开一个类文件,选择window下的perference 按顺序展开Code Templates 可以点击edit按钮自行定义,点击下面的勾选按钮进行勾选,然后保存设置就设置完成了

怎么设置eclipse自动生成注释
工具:eclipse 方法如下:打开Preference,照下图展开,然后选择 Code Templates 选择Files,点击编辑 在编辑模板中就可以进行编写模板样式了,代码就会自动生成注释

相似回答