API documentation Comment Javadoc

Read the API documentation
JDK Package Structure

The JDK package is a set of implemented class libraries developed by Sun,
The JDK divides the class library into several packages, depending on the functionality provided.
Like what
java.io package for operation of input and output,
Java programming language Design Java.lang package for the underlying class, imported by default
Java.math packages that provide a variety of mathematical operations,
java.net packages based on Web applications,
Some common program classes are located in the Java.util package

Document Comment Specification

Javadoc Generating Documents

1. Meaning and specification of document annotations

Use annotations to improve the readability of Java source code, making Java programs clear and easy to distinguish between lines of code and comments. In addition, usually at the beginning of the program to add the author, time, version, the functions to be implemented, and other content annotations, convenient later maintenance and programmer's communication.

/** Enter

Document annotations are generally used in: classes, methods, constants

/*   the function of the * * class is used to test Javadoc * @author  manue1 * @version 1.0 * @see java.lang.String The class can refer to String * @since jdk1.0
    
      starting with JDK1.0 *      /**     * Method Action     * @param    The explanation of the name parameter     * @return             return the     greeting string Contents
     */  /* *          constant Action * *     

Javadoc Command Generation Document

By using the Javadoc command, you can generate an API document for a class that has been written with a document comment, or for all classes under a package

javadoc-d Docdir Nameofpackage

MyEclipse inside through

Progect-->generate Javadoc--->use standard doclet build Index

When doing development, be sure to comment on the method

API documentation Comment Javadoc