AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

JAutodoc - Eclipse Plugin

2011-06-07 1041
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code.
JAutodoc is an Eclipse Plugin for automatically adding Javadoc and file headers to your source code. It optionally generates initial comments from element name by using Velocity templates for Javadoc and file headers. FeaturesJAutodoc has the following features:

Mode Complete existing Javadoc
Existing Javadoc will not be touched. Only missing tags will be added and so far undocumented elements will be documented. Keep existing Javadoc
Existing Javadoc will not be touched. Missing tags will not be added, but so far undocumented elements will be documented. Replace existing Javadoc
Existing Javadoc will be totally replaced by the generated Javadoc. Be sure, if you use this option. Visibility Public, protected, package or private
Decide for which visibilities you like to create Javadoc. Filter Comment Types, Fields, Methods or Getter/Setter only
Decide for which kind of members you like to create Javadoc. Options Add ToDo for auto-generated Javadoc
Add ToDo flag in order to find all sources with auto-generated Javadoc. This is done once only for a source file.

img_dfee0d9a914269b30297e87cae0e5979.gif

Create comment from element name
With this option checked JAutodoc will generate comments from element name as shown below. can be used, to define how this comments will be created. Additionally for fields, methods and parameters shortcut can be defined.

Fields:

img_34ead7d2adbb1c1d3f5123f7cc10a4f3.gif

Methods:

img_ddd9d25a7f2eb757f2369f235b1bed15.gif

Single line field comment
Option to create single line field comments.

img_02eeff3f97bd5e1fadf4c651871183b2.gif

Use Eclipse comment formatter
Use Eclipse internal formatter to format the generated comments. The format can be defined under the preferences of

img_cfd6189bb7a51c4675463b5169c71e22.gif

[G,S]etter from field comment
Create Getter/Setter comments from related field comment. Include subpackages
Include subpackages when adding Javadoc for package members. File Header Add/Replace file header
You can specify a file header that will be added to your source, if no header exists. Optionally, existing headers can be replaced. With option Multi comment header checked, multiple comments at the beginning of the source can be replaced.

Inside header text the Velocity Template Language () and pre-defined can be used.

img_56ec333d8b98061bbc4bf73eb78876e0.gif

Note: In order to use dollar signs inside the header template (e.g. for SVN/CVS properties like $id$) you have to escpape these signs by an backslash (\$). Package Javadoc Edit Template
You can specify the initial content of package.html or package-info.java, which can be added via context menu of package nodes in the Package Explorer.

img_c88d1b25080a9ed6e752f680dd534f45.gif

Like for headers the Velocity Template Language () and pre-defined can be used inside the template.

Use package-info.java
Use package-info.java instead of package.html ReplacementsWhen creating comments from element name, shortcuts inside of fields, methods and parameters can be replaced by another text. For example "set" will be replaced by "Sets the" or "db" can be expanded to "Database".

These replacements can be added, deleted or changed via the . The scope of an replacement can be "Field", "Method" or "Both". Use "Field" for fields and parameters. Optionally only the prefix (Prefix) or every occurrence (All) of the shortcut can be replaced.

Note: Shortcuts are case insensitive. They are detected by changes between upper and lower case letters inside the element name (e.g. setDbName).

Usage For source files opened in Editor Javadoc can be added for all or only for selected members. In this case the modified source file will not be saved automatically to disk.

If the cursor is inside the declaration of an field or method, only this element will be documented. To create a type comment point to the name of the type. Otherwise all members of the current source file will be documented.

img_49c9506e1769c14474b3cefd30cc6460.gif

Selecting the menus with "..." will open an Options Dialog where it's possible to overrule the current project/workspace settings. These settings will only be effective for the current compilation unit and only for this Eclipse session.

img_c971f239330fcecf2cd6a61f98720c4e.gif

In Package Explorer you can select one or more source file(s) in order to add Javadoc. Alternatively, you can select a package and add Javadoc for all package members or you can do it for the complete project.

Caution: Source files which are not opened in the editor will be saved directly to disk. When using the Options Dialog in Editor it's possible to see a Preview of all changes.

img_5e361383b471a44fbc81e5e2e496659e.gif


Task SearchJAutodoc allows to search for tasks like missing Javadoc, file headers or special tags.

img_e5da6b4efe9d62a9269639a96802b5b8.gif

Most of the options are self-explaining. Here's the rest: Generated Javadoc
Search for Javadoc comments that exactly match the one generated by JAutodoc. Outdated file header
Search for file headers that do not match the one generated by JAutodoc. Search For Missing Tags
Search for missing tags like @author. Add a minus to the tags name, if existing tags without message should not be reported or a plus, if only existing tags without message should be reported (e.g. @deprecated without a description).
Changes 2011-04-24 Version 1.9.0 New option: Exclude [G,S]etter New option: Include subpackages when adding Javadoc for package members Bugfix for {@inheritDoc} Contribution to Eclipse help 2010-08-12 Version 1.8.0 Preview Dialog Automatic recognition of global parameter/field prefixes.
(Preferences/Java/Code Style) Support for package-info.java Fixed html tag problem in return doc 2010-03-28 Version 1.7.0 Search page for missing Javadoc and file headers Requires Eclipse 3.4+ 2010-02-09 Version 1.6.0 Support for Eclipse 3.6 New option: [G,S]etter from field comment Support for Generics Escaping of # in templates by \# Fixed encoding problems. Some minor fixes and improvements. Requires JRE 1.5 and Eclipse 3.3+ 2007-09-09 Version 1.5.0 Enhanced prefix/keyword replacement. Escaping of dollar signs in templates by \$ Support for Package Javadoc. 2007-07-10 Version 1.4.0 Project specific settings. Temporary settings for single compilation units. task for Eclipse. Support for multi comment headers. General improvements for Eclipse 3.3 2007-05-01 Version 1.3.0 Using templates for Header and Javadoc. Template variables (e.g. $user, $date, $project_name, ...) Context menu for adding Header only. Filter options for Types, Fields, Methods and Getter/Setter. Corrected order of parameter documentation. Improvement for non-Javadoc. Support for {@inheritDoc}. New Update Site http://jautodoc.sourceforge.net/update/ 2007-01-05: Version 1.2.0 Consider member visibility. Use non-Javadoc for inherited methods. Editor shortcut Ctrl-Alt-J. Selection model in editor changed. Prefix replacement for fields and parameters. 2006-10-20: Version 1.1.0 Single line field comments. Use Eclipse comment formatter. Add/Replace file header. 2006-08-20: Version 1.0.0 Initial version. LicenseJAutodoc is licensed under the Eclipse Public License - v 1.0

JAutodoc comes with the Velocity Template Engine 1.5, which is available under the Apache Software License - v 2.0


Download and InstallationDownload JAutodoc here and unzip the file to the Eclipse directory or use the Update Site

http://jautodoc.sourceforge.net/update/

img_67afa10658b0cfa2ee3d495f2031cb17.gif


ContactJAutodoc is written by Martin Kesting.

文章标签：
Android开发
关键词：
Eclipse plugin
wangccsy
目录
相关文章
一乐乐
|
Java Maven Android开发
eclipse 中 maven的pom.xml文件发生错误：CoreException: Could not get the value for parameter compilerId for plugin execution default-compile: PluginResolutionException: Plugin org.apache.maven...
eclipse 中 maven的pom.xml文件发生错误：CoreException: Could not get the value for parameter compilerId for plugin execution default-compile: PluginResolutionException: Plugin org.apache.maven...
一乐乐
657 0
eclipse 中 maven的pom.xml文件发生错误：CoreException: Could not get the value for parameter compilerId for plugin execution default-compile: PluginResolutionException: Plugin org.apache.maven...
流楚丶格念
|
Java Apache Maven
Eclipse创建maven项目时，出现Could not calculate build plan: Plugin org.apache.maven.plugins:maven-resources错
Eclipse创建maven项目时，出现Could not calculate build plan: Plugin org.apache.maven.plugins:maven-resources错
流楚丶格念
349 0
Eclipse创建maven项目时，出现Could not calculate build plan: Plugin org.apache.maven.plugins:maven-resources错
炉火纯青
|
Java Maven Android开发
eclipse maven 报错Could not get the value for parameter encoding for plugin execution default
问题描述：更改默认的maven仓库路径完成后、即存maven项目或者新建maven项目的时候出现如下错误   Could not get the value for parameter encoding for plugin execution default   原因分析：当问题解决后、回...
炉火纯青
1852 1
技术小阿哥
|
Android开发
eclipse plugin工程（OSGi工程）如何生成ant脚本
技术小阿哥
1217 0
长征2号
|
Android开发
eclipse plugin development -menu
长征2号
1151 0
长征2号
|
Shell Android开发 Java
eclipse preference plugin development store and get
长征2号
1200 0
长征2号
|
Java Android开发
How to programmatically new a java class which implements sepecified interface in eclipse plugin development
长征2号
994 0
cloudcoder
|
Java Scala Android开发
安装scala eclipse plugin导致pom.xml editor打开失败
cloudcoder
2571 0
mikelij
|
Android开发
testng 6.8.6 eclipse plugin
  http://files.cnblogs.com/mikelij/testng.zip
mikelij
685 0
孤剑
|
Java Maven Android开发
eclipse maven plugin 插件 安装 和 配置
原文地址： http://www.blogjava.net/fancydeepin/archive/2012/07/13/382965.html 环境准备： eclipse（Helios） 3.6maven 3.0.4 maven3 安装：     安装 Maven 之前要求先确定你的 JDK 已经安装配置完成。
孤剑
938 0