`

Eclipse 添加注释模板

    博客分类:
  • java
阅读更多

1、生成模板文件把如下代码保存到一个xml文件templates.xml;

<?xml version="1.0" encoding="UTF-8"?>
<templates>
	<template autoinsert="true" context="filecomment_context"
		deleted="false" description="已创建的 Java 文件的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.filecomment" name="filecomment">
/**
 * @Project		${project_name}
 * @File		${file_name}
 * @Package		${package_name}
 * @Version		V1.0
 * @Date		${date} ${time}
 * @Author		sunyunfang@cyou-inc.com
 * Copyright (c) All Rights Reserved, ${year}.
 */
	</template>
	<template autoinsert="true" context="typecomment_context"
		deleted="false" description="创建的类型的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.typecomment" name="typecomment">
/**
 * @Description	${todo}
 * @ClassName	${type_name}
 * @Date		${date} ${time}
 * @Author		sunyunfang@cyou-inc.com
 * Copyright (c) All Rights Reserved, ${year}.
 */
	</template>
	<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="methodcomment_context"
		deleted="false" description="非覆盖方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.methodcomment" name="methodcomment">
/**
 * @Description ${todo}
 * @param ${tags} 参数
 * @return ${return_type} 返回类型 
 * @throws
 */
	</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="constructorcomment_context"
		deleted="false" description="创建的构造函数的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment" name="constructorcomment">
/**
 * Title:${file_name}
 * Description: ${todo}
 * ${tags}
 */
	</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="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="overridecomment_context"
		deleted="false" description="覆盖方法的注释" enabled="true"
		id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">
/**
 * @Description ${todo}
 * @param ${tags} 参数
 * @return ${return_type} 返回类型 
 * @throws
 */
	</template>
</templates>

 2、安装模板文件;

     打开eclipse/myeclipse,选择 window-->Preferences-->JAVA-->Code-->Code Templates 右边点Import 选择你写好的模板templates.xml文件。

 

使用注释模板:

创建新类的时候,勾上“Generate comments”选项即可。新创建的类中,自动添加了你的注释模板中定义好了的注释。

分享到:
评论

相关推荐

    Eclipse Java 注释模板

    Eclipse作为一款强大的Java集成开发环境(IDE),提供了许多便捷的功能,其中之一就是“Eclipse Java 注释模板”。通过配置和使用这些模板,程序员可以快速地为代码添加注释,提高代码的可读性和维护性。下面我们将...

    Eclipse 代码注释模板

    在Eclipse中,用户可以自定义代码注释模板,这通常涉及到类、方法、变量等不同类型的注释结构。`codetemplates.xml`文件就是存储这些自定义模板的配置文件,通过编辑这个文件,我们可以定制符合个人或团队编码规范的...

    Eclipse注释模板和格式化模板.zip

    在Eclipse中,注释模板和格式化模板是两个非常实用的功能,可以帮助开发者快速编写规范、一致的代码。本资料包“Eclipse注释模板和格式化模板.zip”包含了配置这两个功能所需的文件。 首先,我们来看看`code...

    Eclipse Java注释模板.txt

    ### Eclipse Java注释模板知识点详解 #### 一、概述 在进行Java开发的过程中,良好的代码注释习惯不仅能帮助自己快速回顾代码逻辑,还能方便其他开发者理解代码意图,从而提高整个团队的工作效率。Eclipse作为一款...

    Eclipse注释模板自定义

    本篇文章将详细探讨如何在Eclipse中自定义注释模板,以及如何通过`eclipse.ini`配置文件来管理版权信息和团队设置。 一、Eclipse注释模板自定义 1. **打开Eclipse注释模板设置** 要自定义注释模板,首先需要进入...

    eclipse注释模板

    代码格式化和代码注释规范,导入eclipse中,一般在类和方法上都必须加通用文档注释,说明类和方法的作用,在特殊字段加相应注释,在复杂代码逻辑加相应行内注释说明代码逻辑。

    eclipse经典注释模板

    Eclipse是一款广泛使用的Java集成开发环境(IDE),它拥有丰富的功能和高度可定制性,其中就包括了自定义注释模板和代码格式化模板。这些模板对于提高开发效率、保持代码一致性以及提升团队协作有着重要作用。 注释...

    eclipse/Myeclipse注释模板

    本文将详细介绍如何在 Eclipse 和 MyEclipse 中设置和使用注释模板,以及如何导入和配置提供的 "eclipse注释模板"。 1. **Eclipse 和 MyEclipse 注释模板** Eclipse 和 MyEclipse 都允许用户创建和管理自己的代码...

    Eclipse Java注释模板设置详解

    ### Eclipse Java注释模板设置详解 在开发过程中,良好的代码注释习惯对于提高代码的可读性和维护性具有重要作用。Eclipse作为一款流行的Java集成开发环境(IDE),提供了丰富的功能来帮助开发者更好地管理代码和...

    eclipse注释模板xml文件

    在Eclipse中,开发者可以通过自定义注释模板来快速插入预先定义好的注释结构,这对于代码规范和团队协作非常有帮助。这些自定义模板通常存储在一个XML文件中,使得它们可以被共享、导入和导出。 在Eclipse中,注释...

    eclipse注释模板及导入

    - **字段注释模板**:用于描述类的字段,虽然默认可能为空,但可以自定义添加描述信息。 - **方法注释模板**:用于非覆盖方法的注释,可以包含TODO事项和其他描述性标签。 #### 三、导入注释模板的方法 要将自定义...

    Eclipse代码注释模板——code templates

    通过修改`codetemplates.xml`文件,你可以自由定制模板,添加自己的字段、方法或类注释模板。例如,可以创建一个新的方法注释模板,包含参数和返回值的描述: ```xml &lt;![CDATA[ /** * ${tags} * ${...

    eclipse 注释模板

    **Eclipse 注释模板详解** 1. **创建和管理注释模板** 在Eclipse中,你可以通过`Window` -&gt; `Preferences` -&gt; `Java` -&gt; `Code Style` -&gt; `Code Templates`路径来访问和管理注释模板。这里分为三类:`Comments` -&gt;...

    eclipse中代码注释模板

    Eclipse作为一款强大的Java IDE,提供了丰富的自定义功能,包括自定义代码注释模板和代码格式化规则。本文将深入探讨如何在Eclipse中设置和利用这些模板,以实现高效且规范的编码实践。 首先,让我们了解**代码注释...

    eclipse注释模板codetemplates.xml

    自己定义的注释模板,还算比较好用。用法是直接下载文件,在eclipse或myeclipse里面导入(preferences -- code templates -- comments -- import),使用的快捷键是 alt+shift+j,注释就自动加好了。

    Myeclipse/eclipse注释模板一键导入配置

    Eclipse和MyEclipse作为Java开发的主流集成开发环境(IDE),提供了自定义注释模板的功能,使得我们可以快速地生成符合个人或团队风格的注释。本文将详细讲解如何进行"注释模板"的一键导入配置,以及利用提供的文件...

Global site tag (gtag.js) - Google Analytics