玩转Eclipse — 自动注释插件JAutodoc离线下载与安装

代码注释是一种良好的编程习惯。不管对于他人还是自己，注释都有助于代码的阅读和理解。手动添加注释，是一个非常费时和繁琐的工作，严重影响软件开发效率，这也是绝大多数程序员不愿添加注释的主要原因。JAutodoc是一款Eclipse插件，主要用于在源代码文件中自动添加Javadoc和文件头。它使用Velocity templates模板，并依据元素名称生成相应的初始注释。
插件下载地址：https://download.csdn.net/download/qq_21480607/11367607

1. 安装
   1.离线下载
   本地选择压缩包
   点击“Add…”打开Add Repository对话框，如图输入Name，从本地选择压缩包安装路径，点击“OK”。
   
   Eclipse菜单栏上选择 Help -> Install New Software…，进入如下安装界面：
   
   

    选择刚刚添加的JAutodoc，一直点击“Next >”直到安装结束。
   

   2.在线下载
   点击“Add…”打开Add Repository对话框，如图输入Name和Location，点击“OK”。
   其余步骤同上
   下载方法3.
   Eclipse菜单栏上选择 Help -> Eclipse Marketplace…，进入如下界面：搜索JAutodoc，点击下载
   
   2. 设置
   Eclipse菜单栏上选择 Window -> Preferences -> Java -> JAutodoc，进入如下设置界面：
   
   2.1 模式（Mode）
   补全已有Javadoc（Complete existing Javadoc）：已有的Javadoc不会被触及，只会补充遗漏的标签以及还没有文档化的元素。
   保持已有Javadoc（Keep existing Javadoc）：已有的Javadoc不会被触及，遗漏的标签不会补充,但是会文档化之前未文档化的元素。
   替换已有Javadoc（Replace existing Javadoc）：已有的Javadoc将由会被自动生成的Javadoc全部替换掉。（注意谨慎使用这一选项）
   2.2 可见性（Visibility）
   Public，protected，package或者private
   决定为那种可见性层次的属性创建Javadoc。
   2.3 过滤器（Filter）
   注释类型，属性，方法或者只是Getter/Setter
   决定为那种类型的类成员创建Javadoc。
   2.4 选项（Options）
   为自动生成的Javadoc添加ToDo
   添加ToDo是便于找到所有包含自动生成Javadoc的源文件。每个源文件中只生成一次。
   依据元素名创建注释
   设置这个选项后，Jautodoc将依据元素名生成注释。
   单行字段注释
   创建单行注释的选项。
   使用Eclipse的注释格式化
   使用Eclipse内部的格式对生成的注释进行格式化。
   Getter/Setter注释来自于字段注释
   依据字段注释创建Getter/Setter注释。
   包括子包
   当给package成员添加Javadoc时，也为子包添加。
   2.5 文件头（File Header）
   添加文件头
   如果还没有文件头的话，你可以定义一个文件头添加到源文件中。你可以选择将已有文件头替换掉。
   替换已有文件头
   已有的文件头将被自动生成的文件头替换。
   多注释文件头
   对源文件开头的多个注释进行操作。例如，同时选择“替换已有文件头”和“多注释文件头”，自动生成的文件头将会替换源文件的多个已有文件头。
   2.6 包注释（Package Javadoc）
   编辑模板
   你可以为package.html或者package-info.java定义初始内容。可以通过在Package Explorer视图中选择相应包节点右键，选择Add Package Javadoc。
   使用package-info.java
   使用package-info.java而不是package.html。
   2.7 替换（Replacements）
   当根据元素名称创建注释时，可以使用另一文本代替字段，方法和参数中的快捷部分。例如：”set”将被替换成”Sets the”，”db”将被扩展为”Database”等。
   在preferences中可以添加、删除、更改这些替换方式。替换范围可以是字段、方法或者两者兼顾。使用字段范围时对字段和参数都有效。默认情况下只有前缀或者出现缩略词时会替换。

2. 使用
   对于在编辑器中打开的源文件，通过点击右键选择JAutodoc，可以为所有的或者指定的成员添加注释，如下图所示：

    在这种情况下，修改的源文件不会自动保存到硬盘中。如果光标位于一个字段或者方法声明的内部，则只有这个元素将被文档化。要创建一个类型注释，需要光标指向类型名称。否则当前源文件的所有成员都会被文档化。
   
    也可以在Package Explorer视图中，选择一个或多个源文件，或者一个package，甚至整个project，点击右键，选择 JAutodoc -> Add Javadoc，来为其所包含的源文件添加注释。
   

3. Reference
   http://jautodoc.sourceforge.net/