Automatically generate Javadoc documents in eclipse

Source: Internet
Author: User

There are three main ways to use Eclipse to generate documents (Javadoc):
1, right-click in the project list, select Export, and then in the Export dialog box, select Javadoc under Java to submit to the next step.
There are two places to note in the Javadoc Generation dialog box:
Javadoc command: The bin/javadoc.exe of the JDK should be selected
Destination: To create a saved path for a document, you can choose freely.
Press Finish to submit to start generating the document.
2, select by menu: File->export (export from file),
The rest of the steps are the same as the first method.
3, select the project you want to generate the document in, then select it with the menu,
Project->generate Javadoc directly into the Javadoc Generation dialog, the remaining steps are the same as the first method at the beginning of the Javadoc Generation dialog box.

Either way, but there are a few things to consider:
1, eclipse can not generate, error

Java code
    1. Java.lang.IllegalArgumentException at Sun.net.www.ParseUtil.decode

, which is caused by setting the Java environment variable. For example, Classpath is
.; %java_home\lib\dt.jar;%java_home%\lib\tool.jar, the solution is to remove classpath or refer to the official documentation http://maven.apache.org/plugins/ Maven-javadoc-plugin/faq.html.
2, the generation of document garbled problem. Perfecting the Api-doc, when generating Javadoc with Eclipse, the "non-mapped characters encoded GBK" is actually a character encoding problem. Open Eclipse,project, Generate Javadoc A selection of items you want to output Javadoc, add the following code to the VM Setup line in the last step

Java code
      1. -encoding utf-8-charset utf-8

Automatically generate Javadoc documents in eclipse

Related Article

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.