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 Velocitytemplates for Javadoc and file headers.
Features
JAutodoc 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.
Create comment from element name With this option checked JAutodoc will generate comments from element name as shown below. Templates can be used, to define how this comments will be created. Additionally for fields, methods and parameters shortcut Replacements can be defined.
Fields: Methods:
Single line field comment Option to create single line field comments.
Use Eclipse comment formatter Use Eclipse internal formatter to format the generated comments. The format can be defined under the preferences of
[G,S]etter from field comment Create Getter/Setter comments from related field comment
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 (VTL) and pre-defined Variablescan be used.
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.
Like for headers the Velocity Template Language (VTL) and pre-defined Variables can be used inside the template.
Use package-info.java Use package-info.java instead of package.html
Replacements
When 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 preferences. 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.
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.
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.
Task Search
JAutodoc allows to search for tasks like missing Javadoc, file headers or special tags. 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).
笔者配置的如下
header:
/*
* @(#)${file_name} 1.0 ${date}
*
* Copyright ${year} isi Company,Inc.All rights reserved.
* ISITEAM PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.