26_api文档_package的概念_生成自己项目的api文档

1.API

API是什么？
API：Application Programming Interface,应用程序编程接口。

2.package

为什么需要package?

• 为了便于管理类：合适的类位于合适的包！
• 为了解决类之间的重名问题。

package怎么用?

• 通常是类的第一句非注释性语句。
• 包名：域名倒着写即可，再加上模块名，并与内部管理类。
• 其实内部实现就是靠目录结构来做到的。
• 注意事项：
  
  • 写项目时都要加包，不要使用默认包。
  • com.gao和com.gao.car，这两个包没有包含关系，是两个完全独立的包。只是逻辑上看起来后者是前者的一部分。

3.JDK中的主要包

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

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

• java.net－包含执行与网络相关的操作的类。

• java.io－包含能提供多种输入/输出功能的类。

• java.util－包含一些实用工具类，如定义系统特性、使用与日期日历相关的函数。

4.如何生成自己项目的API文档?

特殊的注释：

• —文档注释：/**
• —使用JAVADOC生成API文档
• —解决问题：代码和文档的分离

常用的java注释标签：

• – @Author 作者
• – @version 版本
• – @param 参数
• – @return 返回值的含义
• – @throws 抛出异常描述
• – @deprecated 废弃。建议用户不在使用该方法