高淇三百集之生成自己项目的api文档
API是什么?
API:Application Programming Interface,应用程序编程接口。
API文档是什么?
DK为我们提供了很多类,如何使用这些类。我们可以通过查看API文档来获取信息。API文档就相当于我们学英语用的词典一样!
package包的概念
1、为什么需要package?
为了便于管理类:合适的类位于合适的包!为了解决类之间的重名问题。
2、package怎么用?
通常是类的第一句非注释性语句。包名:域名倒着写即可,再加上模块名,并与内部管理类。其实内部实现就是靠目录结构来做到的。com.sun.testcom.oracle.testcom.bjsxt.gao.testcom.bjsxt.gao.viewcom.bjsxt.gao.view.model
注意事项:
写项目时都要加包,不要使用默认包。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、大数据、人工智能等,可留言或私信领取。