在学习JAVA基础知识和面向对象的时候,我们常说的一句话就是导入某个类,导入某个包,比如用到Scanner的时候要导入一个类,那么里面说的导入到底是导入的什么呢?从今天开始我们将介绍这一部分内容。下面先介绍一下JDKAPI。
什么是JDKAPI
JDK中包含大量的API类库,所谓API(ApplicationProgrammingInterface,应用程序编程接口)就是一些已经写好、可供直接调用的功能(在Java语言中,这些功能以类的形式封装)。
JDKAPI包含的类库功能强大,经常使用的有:字符串操作、集合操作、文件操作、输入输出操作、网格操作、多线程等。
为了便于使用和维护,JDK类库按照包结构划分,不同功能的类划分在不同的包中。经常使用的包如下所示:
文档注释
文档的注释以”/**”开头,以”*/”结束;加在类或方法的开头,用于说明作者,时间,版本要实现功能的详细描述信息。通过javadoc工具,可以轻松的将此注释转换为HTML文档说明;学习者和程序员主要通过文档了解API的功能。
文档注释不同于普通的注释(//...或/*...*/)写在类和方法的开头,专门用于生成供API使用者进行参考的文档资料。
Javadoc命令生成文档
目标HTML文档存储到docDir下,执行以下步骤:
-切换到包含想要生成文档的源文件目录,如有嵌套的包,则必须切换到包含子目录的目录
-如果是一个包,运行命令:java-ddocDirnameOfPackage
-多个包生成文档运行:javadoc-ddocDirnameOfPackage1,nameOfPackage2...
-如果文件在默认包中,运行:javadoc-ddocDir*.java
以上介绍了API的基础知识,下面我们通过一个小案例来深入理解和应用API
案例:规范注释及文档生成(Eclipse)
问题
如下代码,作用如下
1)类JavadocTest的作用是用于测试生成Javadoc文档;作者为jessica;版本为1.0
2)方法hello的作用为获取打招呼的字符串,该方法的参数name表示指定向谁打招呼;该方法返回打招呼的字符串。
使用文档注释,为上述代码添加注释,并生成Javadoc文档
步骤
步骤一:为代码添加文档注释
根据问题的描述,使用/***/为代码添加注释
步骤二:使用Eclipse生成文档注释
首先,点击Project--GenerateJavadoc
点击GenerateJavadoc以后,进入下一界面,选择你要生成的Javadoc的包,或包下的类以及生成的Javadoc所存的路径,默认生成到当前工程目录下
点击Finish,即可生成Javadoc,生成的Javadoc文件如下
点击index.html,查看具体内容。
案例结束,这篇文章通过基础知识和案例相结合的形式,介绍了什么是API以及API的应用,后续还有相关内容的讲解,希望大家多多