Menu
How do I get Sublime Text to automatically generating Javadoc comments for methods? I tried looking around but amounted to nothing.
688
Adding JavaDoc comments The basic rule for creating JavaDoc comments is that they begin with /** and end with */. You can place JavaDoc comments in any of three different locations in a source file: Immediately before the declaration of a public class. Immediately before the declaration of a public field.
In the Package Explorer view, select a Java project and click Project > Generate Javadoc with Diagrams > Automatically. In the Generate Javadoc wizard, under Javadoc command, select the Javadoc command (an executable file). Note: Only Oracle JDK Version 1.4.
A doc comment is written in HTML and must precede a class, field, constructor or method declaration. It is made up of two parts -- a description followed by block tags. In this example, the block tags are @param , @return , and @see .
Step 1 − Open eclipse, select the option Project →Generate Javadoc. Step 2 − Select the javadoc.exe file from the bin folder of java installation directory, select the destination folder for the generated java doc and select Next. finish button.
You might want to try DocBlockr.
It recognizes method parameters correctly and it lets you conveniently tab through the fields (like you do it when using Sublime snippets). But it is not flawless; it seems to have trouble with functions that return arrays, and it adds an @param block for constructors, too.
I guess it depends on how much automation you want.
(Type /** and press enter to trigger it. The gitHub readme has more details on how to use it)
195
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
