JAVA 基础知识整理-05 工具类,API的制作,API的使用

1. 工具类

工具类中的方法一般都是静态方法。

如果只想让调用者通过类名调用,而不能通过创建对象调用,那么可以将工具类的构造方法私有化。

2.说明书的制作(API)

第一步:
在类上面加注:
1.工具类作用说明。
2.@author
3.@version
方法上面加注:
1.功能说明
2.参数说明
3.返回值说明

举例如下:

package smallprogrames;

/**
 * 混合了各种方法的工具类
 * @author Kathy
 * @version 1.0
 * 
 * 
 * */
public class StaticDemo {
	private StaticDemo(){
		
	}
	/**
	 * 打印文字“love you...”,不需要参数,没有返回值 
	 * */
	public static void printLove(){
		System.out.println("love you .....");
	}
	
	/**
	 * 计算两个int类型的整数之和,
	 * @param a 第一个整数参数
	 * @param b 第二个整数参数
	 * @return 返回两个数相加之和
	 * 
	 * */
	public static int sum(int a, int b){
		return a+b;
	}
}

第二步:
如果javadoc.exe不在环境配置中,那么要先在cmd进入javadoc.exe所在的文件夹(安装java的文件夹下的bin目录中),然后输入命令"javadoc -d 目标文件夹路径 -author -version java文件路径"
以上述java文件为例:
在这里插入图片描述生成html API 文件:
在这里插入图片描述index.html
在这里插入图片描述3. 使用API
1)在索引中输入要查看的类名
2)看是否为lang包下的类(除了lang包下的类,其他的全部需要导入)
3)看类的版本
4)类的各部分在API里面对应的名称:

JAVA类的组成 API里面的名称
成员变量 字段摘要
构造方法 构造方法摘要
成员方法 方法摘要

5)查看是否有构造方法

如何调用
有构造方法 创建对象,通过对象来调用
没有构造方法 成员可能都是静态的,那就通过类名来调用

6)查看成员方法

查看内容 作用
是否为static静态方法 如果是就用类名调用
返回值类型 确认调用时是否需要用变量来接收,以及用什么类型的变量接收
方法名 确认需要调用哪种方法
参数 确认是否需要给参数,以及给何种类型的参数
发布了55 篇原创文章 · 获赞 0 · 访问量 2068

猜你喜欢

转载自blog.csdn.net/KathyLJQ/article/details/104224170