API文档注释 Javadoc

阅读API文档
 JDK包结构

JDK包是由sun开发的一组已经实现的类库，、
JDK根据提供的功能不同，将类库划分为若干个包，
比如
用于操作输入输出的　　　　　　　　　　 java.io包，
java程序语言设计基础类的　　　　 　　  java.lang包， 默认导入的
提供各种数学运算的　　　　　　　　　　java.math包，
基于网络应用的　　　　　　　　　　　　java.net包，
一些共用程序类所在的　　　　　　　　　java.util包

文档注释规范

javadoc 生成文档

1. 文档注释的意义及规范

通过注释提高Java源程序代码的可读性；使得Java程序条理清晰，易于区分代码行与注释行。另外通常在程序开头加入作者，时间，版本，要实现的功能等内容注释，方便后来的维护以及程序员的交流。

/** 回车

文档注释 一般会用在 ： 类，方法，常量上

/**

 * 

 * 类的作用用于测试javadoc

 * @author  manue1

 * @version 1.0

 * @see java.lang.String 该类可以参考string

 * @since JDK1.0          始于JDK1.0

 *  





    /**

     * 方法作用

     * @param name    参数的解释

     * @return             返回问候字符串内容

     */





    /**

     * 常量作用

     * 

     * 

    

 javadoc命令生成文档

通过使用javadoc命令，可以将已经编写好的带有文档注释的类，或某个包下的所有类对应的生成一个API文档

javadoc -d docDir nameOfPackage

 

 

Myeclipse里面通过

Progect-->Generate Javadoc--->Use standard doclet  生成索引

 

做开发的时候 一定要方法注释