如何在Eclipse中生成Javadoc HTML文件？

Question

I have written Javadoc style comments like this in my project's code:

/**
 * Description...
 *
 * @param ...
 * @return .....
 */

How can I generate Javadoc HTML files using the Eclipse IDE?

Answer 1

1. Project > Generate Javadoc... .

2. In the Javadoc command: field, browse to find javadoc.exe (usually at [path_to_jdk_directory]\\bin\\javadoc.exe ).

3. Check the box next to the project/package/file for which you are creating the Javadoc.

4. In the Destination: field, browse to find the desired destination (for example, the root directory of the current project).

5. Click Finish .

You should now be able to find the newly generated Javadoc in the destination folder. Open index.html .

Answer 2

This is a supplement answer related to the OP:

An easy and reliable solution to add Javadocs comments in Eclipse:

1. Go to Help > Eclipse Marketplace... .
2. Find "JAutodoc".
3. Install it and restart Eclipse.

To use this tool, right-click on class and click on JAutodoc .

Answer 3

You can also do it from command line much easily.

1. Open command line from the folder/package.

2. From command line run:

   javadoc YourClassName.java

3. To batch generate docs for multiple Class:

   javadoc *.java

Answer 4

To quickly add a Javadoc use following shortcut:

Windows : alt + shift + J

Mac : ⌘ + Alt + J

Depending on selected context, a Javadoc will be printed. To create Javadoc written by OP, select corresponding method and hit the shotcut keys.