java学习笔记03----API文档

网友投稿 636 2022-05-29

26.1 API是什么?

API:Application Programming Interface,应用程序编程接口。

26.2 API文档是什么?

DK为我们提供了很多类,如何使用这些类。我们可以通过查看API文档来获取信息。API文档就相当于我们学英语用的词典一样!

26.3 package包的概念

26.3.1 为什么需要package?

26.3.2 package怎么用?

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

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

其实内部实现就是靠目录结构来做到的。

com.sun.test

com.oracle.test

com.bjsxt.gao.test

com.bjsxt.gao.view

com.bjsxt.gao.view.model

注意事项:

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

com.gao和com.gao.car,这两个包没有包含关系,是两个完全独立的包。只是逻辑上看起来后者是前者的一部分。

26.3.3 JDK中的主要包

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

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

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

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

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

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

•    特殊的注释:

–    文档注释:/**

–    使用JAVADOC生成API文档

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

•    常用的java注释标签:

–    @version 版本

–    @param  参数

–    @return  返回值的含义

java学习笔记03----API文档

–    @throws 抛出异常描述

–    @deprecated 废弃。建议用户不在使用该方法

26.4.1 在eclipse中创建api文档的步骤

1.    右键单击项目,选中export

Java API

版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:【云驻共创】华为云云原生钻石课程13:Istio数据面架构(Envoy)深度解析
下一篇:Python编程:使用pydoc生成文档注释
相关文章