如何在eclipse 中设置自动添加Javadoc注释

如果你是自己写代码而不是开发 Eclipse 插件之类的工具的话，

还是手工写吧，自动添加的跟没添加没有什么不同。

文档应该写得有意义，实践证明自动添加的用眼睛看起来几乎是多余的。

在每个要加注释的方法或类的前面写上 /** 开头和 */ 结尾的就是 javadoc 类型的注释了，之后在菜单上 Project >generate JavaDocs 生成网页吧。

Alt+回车 导入包,自动修正

Ctrl+N 查找类

Ctrl+Shift+N 查找文件

Ctrl+Alt+L 格式化代码

Ctrl+Alt+O 优化导入的类和包

Alt+Insert 生成代码(如get,set方法,构造函数等)

Ctrl+E或者Alt+Shift+C 最近更改的代码

Ctrl+R 替换文本

Ctrl+F 查找文本

Ctrl+Shift+Space 自动补全代码

Ctrl+空格 代码提示

Ctrl+Alt+Space 类名或接口名提示

Ctrl+P 方法参数提示

Ctrl+Shift+Alt+N 查找类中的方法或变量

Alt+Shift+C 对比最近修改的代码

Shift+F6 重构-重命名

Ctrl+Shift+先上键

Ctrl+X 删除行

Ctrl+D 复制行

Ctrl+/ 或 Ctrl+Shift+/ 注释（// 或者 ）

Ctrl+J 自动代码

Ctrl+E 最近打开的文件

Ctrl+H 显示类结构图

Ctrl+Q 显示注释文档

Alt+F1 查找代码所在位置

Alt+1 快速打开或隐藏工程面板

Ctrl+Alt+ left/right 返回至上次浏览的位置

Alt+ left/right 切换代码视图

Alt+ Up/Down 在方法间快速移动定位

Ctrl+Shift+Up/Down 代码向上/下移动。

F2 或Shift+F2 高亮错误或警告快速定位

代码标签输入完成后，按Tab，生成代码。

选中文本，按Ctrl+Shift+F7 ，高亮显示所有该文本，按Esc高亮消失。

Ctrl+W 选中代码，连续按会有其他效果

选中文本，按Alt+F3 ，逐个往下查找相同文本，并高亮显示。

Ctrl+Up/Down 光标跳转到第一行或最后一行下

Ctrl+B 快速打开光标处的类或方法

最常用快捷键

1.Ctrl＋E，可以显示最近编辑的文件列表

2.Shift＋Click可以关闭文件

3.Ctrl＋[或]可以跳到大括号的开头结尾

4.Ctrl＋Shift＋Backspace可以跳转到上次编辑的地方

5.Ctrl＋F12，可以显示当前文件的结构

6.Ctrl＋F7可以查询当前元素在当前文件中的引用，然后按F3可以选择

7.Ctrl＋N，可以快速打开类

8.Ctrl＋Shift＋N，可以快速打开文件

9.Alt＋Q可以看到当前方法的声明

10.Ctrl＋W可以选择单词继而语句继而行继而函数

11.Alt＋F1可以将正在编辑的元素在各个面板中定位

12.Ctrl＋P，可以显示参数信息

13.Ctrl＋Shift＋Insert可以选择剪贴板内容并插入

14.Alt＋Insert可以生成构造器/Getter/Setter等

15.Ctrl＋Alt＋V 可以引入变量。例如把括号内的SQL赋成一个变量

16.Ctrl＋Alt＋T可以把代码包在一块内，例如try/catch

17.Alt＋Up and Alt＋Down可在方法间快速移动

在Java程序中Javadoc注释很重要，但是很多时候注释被漏掉，看看项目中的代码就会知道。如果你结对编程的话，你的伙伴一定会说，“哥们，这儿注释丢掉啦，那个函数的Javadoc注释写的不正确！”。项目中有很多的开发人员，水平和习惯都不太一样，但是对程序中javadoc注释来说，这是不能变化的，要规范起来。如何让每一个人都能养成这样的习惯呢？下面我们就IntelliJ IDEA使用向大家介绍一下。

IDEA默认对Javadoc的支持非常不错，但是这里我们要引入一个插件，那就是JavaDoc Sync Plugin，这两者的结合将非常完美：JavaDoc Sync Plugin会提示你添加javadoc注释及注释同步，而IDEA本身会校验javadoc语法，这样我们的工作就会简单很多。

首先打开Plugin Manager下载并安装JavaDoc Sync Plugin，重启IDEA后在设置面板中选择“Errors”选项，在“Errors”对话框中的文本过滤栏输入javadoc， 这时就会出现和javadoc相关的设置选项 这里我们想对这些设置项进行说明：

Declaration has javadoc problem：这个设置项主要是校验javadoc的语法错误，如不必要的javadoc注释，必需的tag丢失等等。这个设置项有很多的参数设定，你可以参考一下；

Inconsistent Javadoc主要检测javadoc注释冲突，如接口和实行类的javadoc不一致；

Missing Class Javadoc delcaration等提示你应该添加注释。

Severity最右边的小按钮可以设置错误级别显示效果。

有了这些配置，相信你不在会忘记添加javadoc注释啦，因为IDEA会实时地给你指出来（高亮、背景等），这是IDEA的代码审查特性。IDEA同时提供了快速添加和纠错注释功能，只需一个键盘 *** 作，就可以完成注释添加、同步和纠错。

总结：通过以上设置，相信每一个人都会养成编写Javadoc的好习惯，格式统一。如在版本控制系统管理下，java类的注释需要@author和@version tag，这样每个人都会加上，对管理代码有很大的帮助。IDEA同时允许你给不同的错误级别设置不同的显示效果，这样你文档中各种问题进行标识，方便管理。

---