API文档

一、JDK API

1.什么是JDK API

     ·JDK中包含大量的API类库，所谓API（Application Programming Interface，应用程序编程接口）就是一些已写好、可供直接调用的功能（在java中以类的形式封装）

     ·经常使用的有：字符串操作，集合操作、文件操作、输入输出操作、网络操作、多线程操作等等

2.JDK包结构

    ·JDK类库按照包结构划分，不同功能的类划分在不同的包中;
    ·经常使用的包如下所示：
        -java.lang          | Java程序的基础类,如字符串、多线程等，该包中的类使用的频率非常高，不需要import，可以直接使用
        -java.util         | 常用工具类，如集合、随机数产生器、日历、时钟等
        -java.io         | 文件操作、输入/输出操作
        -java.net         | 网络操作
        -java.math         | 数学运算相关操作
        -java.security     | 安全相关操作
        -java.sql         | 数据库访问
        -java.text         | 处理文字、日期、数字、信息的格式 

二、文档注释规范

1.文档注释

    ·以/**开始，以*/结束
    ·在类和方法（常量上也可以）的开头，用于说明作者，时间，版本，要实现功能的详细描述等信息
    ·通过javadoc工具，可以轻松的将此注释转换为HTML文档说明；学习者和程序员主要通过文档了解API功能
    ·文档注释不同于普通注释（//...或/*...*/）,普通注释写在程序之中，用于程序员进行代码维护和交流,无法通过工具生成文档；而文档注释写在类和方法的开头，专门用于生成供API使用者进行参考的文档资料。
    

    2.文档注释规范

    /**
    *类或方法功能说明
    *
    *@auther 作者
    *@version 版本号（一般用小数表示，大版本号.小版本号，如1.204），日期    
    *@see 参见（类要参考其他类时用）
    *@since JDK1.0始于jdk版本
    *
    */
    
  

 3.javadoc命令生成文档 

    ·项目->右击->export->Java->Javadoc->next->选中项目，以及路径->finish
    ·目标HTML文档存储到docDir下，执行以下步骤：
        -切换到包含想要生成文档的源文件目录。如果有嵌套的包，则必须切换到包含子目录的目录
        -如果是一个包，运行命令 javadoc -d docDir nameOfPackage
        -多个包生成文档，运行 javadoc -d docDir nameOfPackage1, nameOfPackage2...
        -如果文件在默认包中，运行 javadoc -d docDir *.java