Eclipse 如何设置注释的

（1）.单行(single-line)注释：“//……”

（2）.块(block)注释：“/*……*/”

（3）.文档注释：“/**……*/”

（4）.javadoc注释标签语法

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

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

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

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

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

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

@return_type返回类型

@date 日期

@time时间

打开Eclipse/MyEclipse工具，打开或创建一个Java工程，点击菜单Window->Preferencesd出首选项设置窗口

2

展开左侧Java->Code Style->Code Template选项列表，就可以看到所有需设置注释的元素了

3

展开右侧模板选项Comments，可以看到可以设置的注释模板类型，包含Files,Types,Fields,Constructors,Methods等内容

4

点击Types，下方Pattern区域会显示类注释模板内容，点击右则的Edit按钮可以对注释模板内容进行修改

5

例如：我习惯的注释格式如下：/*** <p>Title: </p>* <p>Description: </p>* <p>Company: </p>* @author * @date */

因此在pattern区域输入以上内容

6

将鼠标放在title后面，点击下方的Insert variable按钮，d出的变量列表中，选择typename

7

同理在@author后面输入${user},在@date 后面输入${date} ${time}变量，如此类的注释便定义完成了

8

在实际开发过程中，新建一个类以后，通过输入/**，然后回车即自动按照刚才定义的注释模板格式补齐注释内容，也可以按shift+alt+j快捷键完成该动作

END

在Eclipse中自动添加注释和自定义注释风格的方法：

1、Eclipse菜单栏上选择 Window ->Preferences ->Checkstyle，进入如下设置界面：

2、在Global Check Configurations框中，列出可以选择的检查配置（Check Configuration），Default栏标记为对勾的默认配置。

如果想自己配置检查选择，可以点击“New...”按钮新建一个配置，进入如下Check Configuration界面：

3、检查配置的类型，可以有多种选择。Internal Configuration类型是检查配置存在于Eclipse内部；External Configuration类型相当于导入一个已有的xml配置文件。Checkstyle配置都是xml文件。

下面这段代码经过Checkstyle检查之后，不符合规范的代码，底色都会被标记为浅黄色进行提示。点击行头的提示标记，就会显示具体不符合规范的地方。示例如下图所示：

---