Inspired by the AutoFormatText plug-in this plug-in reformats JavaDoc comments.
It rewraps the comments and aligns the parameters.
Copy the jar file to your IDEA/plugins directory.
Move the cursor to the JavaDoc comment you want to reformat and press Ctrl-Alt-D.
- Novmeber 15, 2002: Version 0.4
- November 11, 2002: Version 0.3
- Preserve empty lines in JavaDoc
- Configurable parameter alignment
- November 8, 2002: Version 0.2
- November 6, 2002: Version 0.1
-- DarioZogg - 06 Nov 2002
- great work
-- RahelLuethy - 09 Nov 2002
- Nice indeed
Suggestions:
- Preserve empty lines in javadocs
- Even better, when dealing with a white line look for a <P> tag and if none is found, add it
- Invoking JavaDocFormatterPlugin? in a non-javadoc comment generates an NPE.
- Oh, and it lines up the description text after @param tags very far on the right.. Maybe it could figure out what the longest parameter is in the list and align based on that
-- VinceMallet - 11 Nov 2002
- Yes, this seems like a very useful plugin. Just a couple of additional suggestions to make it even better, in case you have nothing else to do
- Special treatment for <PRE>...</PRE>: Don't reformat it at all.
- Special treatment for HTML lists, such as <UL> <LI> first bullet <LI> second bullet ... </LI> -- right now the plugin messes up my lists. This could be formatted with each tag starting its own new line (<UL>, <LI>, ..., </UL>).
- Extend it to make it work on ordinary block comments too
- Extend it to make it work on consecutive lines of line comments
- Make it possible to run it on an entire Java file
- Make it possible to run it on an entire directory, like "Reformat Code"
- Add an option not to break lines inside {@link ...}
- -- JonasKvarnstrom - 25 Nov 2002
|
|