`
a137268431
  • 浏览: 157746 次
文章分类
社区版块
存档分类
最新评论

eclipse代码注释的设置

 
阅读更多

1. eclipse用户名的设置:

在eclipse的安装路径下,打开eclipse.ini的配置文件,如下图:

在-vmargs下加入:-Duser.name=你的名字


2. 注释格式以及各个主要简介

(1).单行(single-line)注释:“//……”

(2).块(block)注释:“/*……*/”

(3).文档注释:“/**……*/”

(4).javadoc注释标签语法

@author对类的说明标明开发该类模块的作者

@version 对类的说明标明该类模块的版本

@see对类、属性、方法的说明参考转向,也就是相关主题

@param 对方法的说明对方法中某参数的说明

@return对方法的说明对方法返回值的说明

@exception 对方法的说明对方法可能抛出的异常进行说明

@return_type返回类型

@date 日期

@time时间

3类、方法、重写方法等类型的注释添加

打来:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点,选中你要添加注释的类型,

然后点击edit,就是所有需设置注释的元素。现就每一个元素逐一介绍:

点击edit后,在pattern里按“ctrl“+”/”键,选择要添加的种类,例如日期,作者、时间、返回类型等等……

设置好以后,会在上图的pattern下生成相应代码,如下图所示:

(1)文件(Files)注释标签:

目前没有用到,可以不用设置。

(2)类型(Types)注释标签(类的注释):

规范:

/**

*类的描述

*@authoryourname

* @Time 2012-11-20 14:49:01

*

*/

注释的pattern:

/**

*@Description:${todo}

*@author:${user}

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

*/

(3)字段(Fields)注释标签:

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

暂时用不到


(4)构造函数标签(Constructor):

规范:

/**

*构造方法的描述

*@paramname

*按钮的上显示的文字

*/

Pattern:

/**

*@Description:${todo}

* ${tags}

*/

(5)方法(Methods)标签:(接口和其实现类的方法,都要加注释)

注释规范:

/**

*为按钮添加颜色

*@paramcolor

按钮的颜色

*@return

*@exception(方法有异常的话加)

* @authorAdministrator

* @Time 2012-11-20 15:02:29

*/

Pattern:

/**

*@Description:${todo}

* ${tags}

* ${return_type}

*@exception:

*@author: ${user}

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

*/

(6)覆盖方法(Overriding Methods)标签:

(7)代表方法(Delegate Methods)标签:
(8)getter方法标签:

(9)setter方法标签:

这些暂时没有定义,可以按照自己的方式添加注释。

分享到:
评论

相关推荐

    Eclipse 代码注释模板

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

    Eclipse代码注释模板——code templates

    **Eclipse代码注释模板** Eclipse的代码注释模板允许用户自定义不同类型的注释模板,如类、方法、变量等。这些模板可以在编写代码时自动插入,减少手动输入的时间。模板支持包括但不限于以下类型: 1. 类注释...

    Eclipse代码注释模板

    Eclipse代码注释模板,可以用于myeclipse等开发IDE,注释包括Class,method等

    eclipse代码注释风格

    本文将详细讲解Eclipse中的代码注释风格,以及如何设置和使用这些风格。 一、代码注释类型 Eclipse支持三种主要的注释类型: 1. 单行注释:以`//`开始,用于快速添加临时或简单的注释。 2. 多行注释:以`/*`开始,...

    eclipse代码注释模板

    eclipse代码注释模板 。

    eclipse 代码注释模板(很实用)

    eclipse 代码注释模板(很实用)

    Eclipse Java 注释模板

    在编程世界中,提高效率是每个开发者追求的目标之一。...通过合理的配置和使用,它可以帮助开发者快速创建高质量的代码注释,让代码更易读、更易维护。在日常工作中,我们应该充分利用这样的功能,提高编程的生产力。

    eclipse 代码 注释模板xml

    将代码注释以xml形式,直接导入eclipse。免去了繁琐的一步步的配置

    Eclipse代码注释模版-codetemplates.xml

    Eclipse代码注释模版-codetemplates

    eclipse代码注释模版下载

    eclipse代码注释模版下载

    eclipse注释模板

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

    Eclipse Java注释模板.txt

    Eclipse作为一款非常受欢迎的Java集成开发环境(IDE),提供了强大的功能来支持用户自定义代码注释模板,这有助于保持代码的一致性和可读性。 #### 二、Eclipse Java注释模板配置方法 要在Eclipse中设置Java注释...

    eclipse代码/注释规范

    以下是一些关于Eclipse代码和注释规范的关键知识点: 1. **编码风格**:Eclipse支持多种编码风格,如Sun Java编程规范或Google Java编程规范。这些风格通常规定了命名约定(如变量、类和方法名)、缩进和空格的使用...

    eclipse第二代代码行数、注释行数检查插件

    3. **实时更新**:当开发者在Eclipse中编辑代码时,插件会实时更新代码和注释的统计信息,提供即时反馈,帮助开发者保持代码质量和结构的良好状态。 4. **项目级别统计**:除了单个文件,插件还可以在整个项目范围...

    Eclipse自动注释代码

    Eclipse自动注释代码

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

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

    Eclipse注释模板自定义

    Eclipse作为一款流行的Java集成开发环境(IDE),提供了丰富的自定义选项,其中包括注释模板的设置。本篇文章将详细探讨如何在Eclipse中自定义注释模板,以及如何通过`eclipse.ini`配置文件来管理版权信息和团队设置...

Global site tag (gtag.js) - Google Analytics