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

Posted 2023-05-17

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

　　1、打来eclipse：首先打开eclipse，然后随意打开一个java类文件，最好找一个没有注释的类，方便实践一下；

　　2、打开perference：在已经打来的eclipse中，点击顶部工具栏中的window目录下的perference按钮，进入perference窗体；

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

　　4、设置风格和进行勾选：

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

　　5、选中方法体测试：

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

　　6、查看效果：

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

参考技术A 先看默认状态的吧，新建类文件时，是不生成注释的

在
windows-->preferenceJava-->Code Style-->Code Templatescode-->new Java file

编辑文件为7的样式，（为了方便起见，中间分布截图说明，熟悉的朋友直接跳到7）
对于中文版本
窗口-->首选项
java-->代码样式-->代码模板
代码-->新的java文件
菜单栏，窗口——首选项

找到java选项-->代码样式

注释-->新生成的java文件

直接编辑配置文件
在配置文件中间添加注释代码，这部分可以自定义，参考如下，关键字解释见后文10
------------------我是分割线，别复制我-----------------------------------
$filecomment$package_declaration/** * @author 作者 E-mail: * @date 创建时间：$date $time * @version 1.0 * @parameter * @since * @return */$typecomment$type_declaration
------------------我是分割线，别复制我-----------------------------------
现在新建文件将自动生成注释

补充说明;
也许你看到我们在写注释文件时用到了很多关键字，那么这里我们就了解一下Javadoc
Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了
关键词列表：
@author 作者名
@date 日期
@version 版本标识
@parameter 参数及其意义
@since 最早使用该方法/类/接口的JDK版本
@return 返回值
@throws 异常类及抛出条件
@deprecated 引起不推荐使用的警告
@see reference 查看引用
@override 重写本回答被提问者采纳 参考技术B

　　方法如下：

Window->Preference 打开参数设置面板，然后选择：Java -> Code Style -> CodeTemplates



点击Edit，进入编辑模式，这样就可以自定义注释了。其中可以插入一些变量，如日期、文件名、作者等等。

　　

参考技术C /** + 空格

Eclipse中设置作者日期等Java注释模板

Eclipse作为JavaIDE（Integrated Development Environment,集成开发环境）,可以通过设置自动添加Javadoc注释信息，如@author 作者名、@version 版本标识、@date 日期等，在创建类或新增方法时会自动添加注释信息。关于java如何生成javadoc文档可参考下文。下面将会为大家介绍如何在Eclipse中设置Java注释模板。

 首先介绍几个常用的注解：

@author 作者名

@date 日期

@version 版本标识

@parameter 参数及其意义

@return 返回值

@throws 异常类及抛出条件

@deprecated 引起不推荐使用的警告

@override 重写

这个注解我们在java代码中经常可以看到。

1.  

2. 设置注释模板的步骤：点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates，对右侧Comments选项中具体的注释信息进行编辑即可。可勾选上自动添加注释信息，在生成java文件时便会自动生成注释，当然也可以手动插入注释。设置的界面如下：

   
3.  

   点击Edit按钮，进入编辑页面，全部编辑完成后点击“Apply And Close”即可设置完成，并关闭设置页面。

   

   
4.  

   下面介绍具体的Comment如何设置：

   1. 点击Comments下的Files可对整个Java文件进行注释：包括公司名称，版权所属，作者信息，日期等。

    

   /**  

   * <p>Title: ${file_name}</p>  

   * <p>Description: </p>  

   * <p>Copyright: Copyright (c) 2017</p>  

   * <p>Company: www.baidudu.com</p>  

   * @author shenlan  

   * @date ${date}  

   * @version 1.0  

   */  

5.  

   2. 点击Types对类进行注释：

    

   /**  

   * <p>Title: ${type_name}</p>  

   * <p>Description: </p>  

   * @author shenlan  

   * @date ${date}  

   */  

   3. 点击Fields对字段进行注释：

   /** ${field}*/  

   4. 点击Constructors对构造方法进行注释：

   /**  

   * <p>Title: </p>  

   * <p>Description: </p>  

   * ${tags}  

   */  

   5. 点击Methods对方法进行注释：

   /**  

    * <p>Title: ${enclosing_method}</p>  

    * <p>Description: </p>  

    * ${tags}  

    */  

6.  

   6. 点击Overriding Methods对重写方法进行注释：

   /* (non-Javadoc)  

    * <p>Title: ${enclosing_method}</p>  

    * <p>Description: </p>  

    * ${tags}  

    * ${see_to_overridden}  

    */

   7. Delegate methods对代表方法进行注释：

   /**  

   * ${tags}  

   * ${see_to_target}  

   */

   8. Getters对get方法进行注释：

   /**

    * @return the ${bare_field_name}  

    */

   9. Setters对set方法进行注释：

   /**

    * @param ${param} the ${bare_field_name} to set  

    */

7.  

   注释模板的导入和导出：点击Import和Export按钮即可。

   
8. 在设置模板时如果勾选了自动添加注释信息，则在创建Java文件时会自动生成文档和类的注释信息，若没有勾选，按Shift+Alt+J快捷键也可生成。
9. 在对类中的方法进行注释是：在方法上方输入/** 后点击回车，即可生成方法注释；或将光标放在方法名上，按住Shift+Alt+J快捷键也可；或在方法上右击，source》Generate Element Comment也可生成注释。