JAutodoc - Eclipse插件
JAutodoc是一个Eclipse 插件，用于自动将Javadoc和文件头添加到源代码中。它可以通过使用 Javadoc的Velocity 模板和文件头来选择性地从元素名称生成初始注释 。
特征
JAutodoc具有以下功能：
现有的Javadoc将不会被触及。只有缺失的标签将被添加，并且迄今未记录的元素将被记录。
保持现有的Javadoc
现有的Javadoc不会被触及。缺少标签将不会被添加，但是迄今未记录的元素将被记录。
替换现有的Javadoc
现有的Javadoc将完全由生成的Javadoc替代。请确定，如果你使用这个选项。
能见度
公开，保护，包装或私人
决定您想要创建Javadoc的可见性。
过滤
仅评论类型，字段，方法或Getter / Setter
决定您想要创建Javadoc的成员类型。
选项
为自动生成的Javadoc
添加待办事项标志添加待办事项以便使用自动生成的Javadoc查找所有来源。这只对源文件完成一次。
从元素名称创建注释
选中此选项JAutodoc将从元素名称生成注释，如下所示。 可以使用模板来定义如何创建这些评论。此外， 可以定义字段，方法和参数快捷方式替换。
领域：
方法：
单行字段注释
用于创建单行字段注释的选项。
使用Eclipse注释格式化程序
使用Eclipse内部格式化程序来格式化生成的注释。格式可以根据偏好进行定义
[G，S] etter from field comment
创建来自相关字段评论的Getter / Setter注释。
仅限第一句只
使用第一句或完整的字段评论。
替换现有的[G，S] etter
替换或保留现有的[G，S] etter注释。
包含子
包在为包成员添加Javadoc时包含子包。
标签顺序
配置Javadoc标签顺序。
如果不存在标题，您可以指定将添加到源文件的文件标题。可选地，现有标题可以被替换。通过选中多注释标题选项，可以替换源头的多个注释。
在标题文本内部，可以使用速度模板语言（VTL）和预定义的 变量。
注意： 为了在标题模板中使用美元符号（例如，像$ id $这样的SVN / CVS属性），你必须用反斜线（\ $）来隐藏这些符号。
包Javadoc
编辑模板
您可以指定package.htmlor 的初始内容package-info.java，可以通过Package Explorer中包节点的上下文菜单添加。
与标题一样，速度模板语言（VTL）和预定义的 变量可以在模板中使用。
使用package-info.java
使用package-info.java的，而不是package.html
更换
从元素名称创建注释时，字段，方法和参数中的快捷键可以被另一个文本替换。例如“set”将被替换为“Sets”或“db”可以扩展为“Database”。
这些替换可以通过首选项添加，删除或更改。替换的范围可以是“字段”，“方法”或“两者”。字段和参数使用“字段”。可选地，只能替换快捷方式的前缀（前缀）或每次出现（全部）。
注意： 快捷方式不区分大小写。它们通过元素名称中的大写和小写字母之间的变化（例如setDbName）进行检测。
导入/导出全部...
将完整配置从/导入/导出到单个文件。
清理文件标题并保存操作
在清理或每次保存Java编辑器时添加/替换文件头。
用法
对于在编辑器中打开的源文件，Javadoc可以添加所有或仅用于选定的成员。在这种情况下，修改后的源文件将不会自动保存到磁盘。
如果游标位于字段或方法的声明中，则仅记录此元素。创建类型注释点到类型的名称。否则，当前源文件的所有成员都将被记录。
使用“...”选择菜单将打开一个选项对话框 ，在该对话框中可以取消当前的项目/工作区设置。这些设置仅对当前编译单元有效，且仅对此Eclipse会话有效。
警告： 编辑器中未打开的源文件将直接保存到磁盘。
在编辑器中使用选项对话框时，可以看到所有更改的 预览。
任务搜索
JAutodoc允许搜索像缺少Javadoc，文件头或特殊标签的任务。
大多数选项都是自我解释。剩下的是： 生成的Javadoc 搜索与JAutodoc生成的完全匹配的Javadoc评论。 过时的文件头 搜索与JAutodoc生成的文件头不匹配的文件头。 搜索缺少的标签 搜索像@author这样的缺失标签。如果没有消息的现有标签不应该被报告，或者加号，如果只有没有消息的现有标签应该被报告（例如@不需要描述），则向标签名称添加减号。 下载和安装 在此处下载JAutodoc 并将文件解压缩到Eclipse目录或使用更新站点 http://jautodoc.sourceforge.net/update/
特征
JAutodoc具有以下功能：
模式
完整现有的Javadoc现有的Javadoc将不会被触及。只有缺失的标签将被添加，并且迄今未记录的元素将被记录。
保持现有的Javadoc
现有的Javadoc不会被触及。缺少标签将不会被添加，但是迄今未记录的元素将被记录。
替换现有的Javadoc
现有的Javadoc将完全由生成的Javadoc替代。请确定，如果你使用这个选项。
能见度
公开，保护，包装或私人
决定您想要创建Javadoc的可见性。
过滤
仅评论类型，字段，方法或Getter / Setter
决定您想要创建Javadoc的成员类型。
选项
为自动生成的Javadoc
添加待办事项标志添加待办事项以便使用自动生成的Javadoc查找所有来源。这只对源文件完成一次。
从元素名称创建注释
选中此选项JAutodoc将从元素名称生成注释，如下所示。 可以使用模板来定义如何创建这些评论。此外， 可以定义字段，方法和参数快捷方式替换。
领域：
方法：
单行字段注释
用于创建单行字段注释的选项。
使用Eclipse注释格式化程序
使用Eclipse内部格式化程序来格式化生成的注释。格式可以根据偏好进行定义
[G，S] etter from field comment
创建来自相关字段评论的Getter / Setter注释。
仅限第一句只
使用第一句或完整的字段评论。
替换现有的[G，S] etter
替换或保留现有的[G，S] etter注释。
包含子
包在为包成员添加Javadoc时包含子包。
标签顺序
配置Javadoc标签顺序。
文件标题
添加/替换文件标题如果不存在标题，您可以指定将添加到源文件的文件标题。可选地，现有标题可以被替换。通过选中多注释标题选项，可以替换源头的多个注释。
在标题文本内部，可以使用速度模板语言（VTL）和预定义的 变量。
注意： 为了在标题模板中使用美元符号（例如，像$ id $这样的SVN / CVS属性），你必须用反斜线（\ $）来隐藏这些符号。
包Javadoc
编辑模板
您可以指定package.htmlor 的初始内容package-info.java，可以通过Package Explorer中包节点的上下文菜单添加。
与标题一样，速度模板语言（VTL）和预定义的 变量可以在模板中使用。
使用package-info.java
使用package-info.java的，而不是package.html
更换
从元素名称创建注释时，字段，方法和参数中的快捷键可以被另一个文本替换。例如“set”将被替换为“Sets”或“db”可以扩展为“Database”。
这些替换可以通过首选项添加，删除或更改。替换的范围可以是“字段”，“方法”或“两者”。字段和参数使用“字段”。可选地，只能替换快捷方式的前缀（前缀）或每次出现（全部）。
注意： 快捷方式不区分大小写。它们通过元素名称中的大写和小写字母之间的变化（例如setDbName）进行检测。
导入/导出全部...
将完整配置从/导入/导出到单个文件。
清理文件标题并保存操作
在清理或每次保存Java编辑器时添加/替换文件头。
用法
对于在编辑器中打开的源文件，Javadoc可以添加所有或仅用于选定的成员。在这种情况下，修改后的源文件将不会自动保存到磁盘。
如果游标位于字段或方法的声明中，则仅记录此元素。创建类型注释点到类型的名称。否则，当前源文件的所有成员都将被记录。
使用“...”选择菜单将打开一个选项对话框 ，在该对话框中可以取消当前的项目/工作区设置。这些设置仅对当前编译单元有效，且仅对此Eclipse会话有效。
在包资源管理器中，您可以选择一个或多个源文件以添加Javadoc。或者，您可以选择一个软件包并为所有软件包成员添加Javadoc，或者您可以为完整的项目执行此操作。
警告： 编辑器中未打开的源文件将直接保存到磁盘。
在编辑器中使用选项对话框时，可以看到所有更改的 预览。
任务搜索
JAutodoc允许搜索像缺少Javadoc，文件头或特殊标签的任务。
大多数选项都是自我解释。剩下的是： 生成的Javadoc 搜索与JAutodoc生成的完全匹配的Javadoc评论。 过时的文件头 搜索与JAutodoc生成的文件头不匹配的文件头。 搜索缺少的标签 搜索像@author这样的缺失标签。如果没有消息的现有标签不应该被报告，或者加号，如果只有没有消息的现有标签应该被报告（例如@不需要描述），则向标签名称添加减号。 下载和安装 在此处下载JAutodoc 并将文件解压缩到Eclipse目录或使用更新站点 http://jautodoc.sourceforge.net/update/