【JDK API】
1、什么是JDK API
JDK中包含大量的API类库,所谓API(Application Programming Interface,用户程序编程接口)就是一些已写好、可供直接调用的功能(在Java语言中,这些功能以类的形式封装)。
JDK API包含的类库功能强大,经常使用的有:字符串操作、集合操作、文件操作、输入输出操作、网站操作、多线程等等。
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、文档注释规范
/**
*TheStringclass represents character strings…
*…… 类功能说明
*@author Lee Boynton 作者
*@version 1.204,06/09/06 版本
*@see java.lang.StringBuffer 参见
*@since JDK1.0 使于JDK版本
*/
public final class String implements java.io.Serializable,Comparable,CharSequence{
……
}
/**
*… 方法功能说明
*
*@param charsetName The name of a supported
*@return The resultant byte array
*@throws UnsupportedEncodingException
*If the named charset is not supported
*/
public byte[] getBytes(String charsetName){
……
}
3、javadoc命令生成文档
目标HTML文档存储到docDir下,执行以下步骤:
1)切换到包含想要生成文档的源文件目录。如果有嵌套的包,则必须切换到包含子目录的目录
2)如果是一个包,运行命令
3)javadoc-d docDir nameOfPackage
4)多个包生成文档,运行
5)javadoc-d docDir nameOfPackage1,nameOfPackage2…
6)如果文件在默认包中,运行
7)javadoc-d docDir *.java
领取专属 10元无门槛券
私享最新 技术干货