Generate JavaDoc and intellijjavadoc for the self-designed class library in IntelliJ IDEA.

Source: Internet
Author: User

Generate JavaDoc and intellijjavadoc for the self-designed class library in IntelliJ IDEA.

A project needs to develop an XML analysis processor for other siblings in the team and design it as a class library to provide corresponding API interfaces. To facilitate your use, you need to generate the corresponding JavaDoc help document, just like the JavaDoc provided by the JavaSE standard library. My development tool is IntelliJ IDEA 12.1.6, which provides a good JavaDoc generation function and the standard JavaDoc annotation conversion function. Its essence is in the Code compiling process, write comments for the classes, methods, and other Members that need to be exposed to the user according to the standard JavaDoc annotation requirements. Then, the IDEA function is used to automatically call javadoc.exe (JDK's built-in tool) to automatically generate JavaDoc documents (Hyper Text Format) based on the comments in the source code ). You can easily find the standard JavaDoc annotation rules on the Internet. Pay special attention to the following points:

 

After JavaDoc is generated, you can find the index.html file in its root directory. Open it and you will see our own standard JavaDoc API documentation.

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.