API文档的阅读

API文档的阅读

API是什么?

--Application Programming Interface 应用程序编程接口 

Package的简单使用

--java中的核心包:java.lang包

 Package 所有的包

 

All Classes所有的类

中间的是介绍：

Package包的用法

为什么需要package

--为了解决类之间的重名问题.

--为了便于管理类:合适的类位于合适的包!

Package怎么用?

--通常是类的第一句非注释性语句.

--包名:域名倒着写即可,再加上模块名,并与内部管理类.

 注意事项:

写项目时都要加包,不要使用默认包.

Com.gao和com.gao.car,这两个包没有包含关系,是两个完全独立的包.

只是逻辑上看起来后者是前者的一部分。 

JDK中主要的包

Java.lang

包含一些java语言的核心类，如：String、Math、Integer、System和Thread，提供常用功能。

Java.awt

包含了构成抽象窗口工具集( abstract window toolkits )的多个类,这些类被用来构建和管理应用程序的图形用户界面(GUI).

Java.net

包含执行与网络相关的操作的类.

Java.io

包含能提供多个输入/输出功能的类.

Java.util

包含一些实用工具类,如定义系统特性,使用与日期日历相关的函数

 

生成自己项目的API文档

特殊的注释:

--文档注释:/** 

使用JAVADOC生成API文档

--解决问题:代码和文档的分离

常用的java注释标签:

-- @Author 作者

--@version 版本

--@param参数

--@return 返回值的含义

--@throws 抛出异常描述

--@deprecated 废弃,建议用户不在使用该方法

 Eclipse软件编译器 ，如何生成API文档!

点击项目右击选择Export...  然后选择java 选择javadoc 选中

弹出Javadoc Generation窗口  javadoc command指调用java下的一个程序命令(  C:\Program Files\Eclipse Adoptium\jdk-17.0.2.8-hotspot\bin\javadoc.exe  )

Create javadoc for members with visibility: 这里是可见性的问题默认是public

Use standard doclet 单选框  Destination 是目标生成的文件夹  后点击确认finish