Question

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

Answer 1

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

1. 打开eclipse，打开一个没有注释的java类
   

2. 点击window标签下面的perference
   

   

3. 在perference窗体的左边栏中，输入Code Templates ,按回车键回车，就能快速定位到Code Templates；
   

   

4. 在Code Template 中找到comment目录，该目录下就是有关注释的相关代码风格设置，这里有各种类型，字段，类型，构造方法以及继承的方法，这里面已经是系统默认的注释，可以点击edit按钮自行定义，现在重要的是点击下面的勾选按钮进行勾选，然后保存设置；
   

   

5. 在eclipse代码编辑区域，选中一方法，该方法实现了某接口定义的方法，像图中所示选中它，按快捷键Shift+Alt+J;
   

   

6. 经过上面的快捷键操作，就能看到，Javadoc注释的代码已经自动添加到编辑方法体上面，方便以后开发的阅读，提高效率！
   

   

Answer 2

如果你是自己写代码而不是开发 Eclipse 插件之类的工具的话， 还是手工写吧，自动添加的跟没添加没有什么不同。 文档应该写得有意义，实践证明自动添加的用眼睛看起来几乎是多余的。 在每个要加注释的方法或类的前面写上 /** 开头和 */ 结尾的就是 javadoc 类型的注释了，之后在菜单上 Project > generate JavaDocs 生成网页吧。