How to create a Help document (API) for Java

Source: Internet
Author: User

How to create a Help document (API) for Java

The steps are as follows :
(1) Write a tool class
(2) Add a document comment to this class
(3) Parsing document annotations with tools
Javadoc Tools
(4) format
javadoc-d Directory-author-version Arraytool.java

Make a Help document (API) Error Resolution:
Cannot find a public or protected class that can be documented
This statement tells us that there is not enough permission on the class you want to manipulate. Add public to the front of the class.
As shown in 02:


---------------------------------------
  When we do development in the future, the things we give to others are xxx.class files and help documents (APIs). Others use the Xxx.class file through the Help documentation (API).
  This is the object-oriented thinking, I do not care how you achieve it! I will be able to meet your terms.

How to create a Help document (API) for Java

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.