帮助文档的使用和制作
当我们想要了解JDK中到底给了我们什么类和方法的时候。我们就需要去打开帮助文档(又叫做API),Ctrl+F来搜索我们想要了解的类。
帮助文档的使用
帮助文档是.CHM文件,.CHM文件是微软新一代的帮助文件格式,利用HTML作源文,把帮助内容以类似数据库的形式编译储存。因为使用方便,形式多样也常被采用作为电子书的格式。(这个资源已经被上传过,博主无法再次上传,所以需要请自行百度下载)
我们下载完成后,打开文件就是上面那个图的格式,当我们想要搜索哪个类的工具的时候,就直接在首页进行Ctrl+F搜索,比如:
(记得箭头所指,选中全字匹配和区分大小写),搜索之后点进去。
然后接着是一些介绍。比较重要的是中间的构造方法和其他方法:
当我们见过了这些文档,我们会感觉好方便,想了解什么就去打开文件搜索就好了,虽然没有其他博文上的详细,但是更便捷,比如没有网络的时候。
然后我们在想,如果自带的类中没有自己想要的工具方法,然后在学习和工作中,我自己又写了很多的工具类,已经记不清楚有多少和都是做什么的怎么办,其实,这个JAVA开发公司已经想到了这一点,准备好了方法供我们去使用,制作自己的帮助文档。
帮助文档的制作。
我们之前在学习注释方式的时候,我们知道有三种注释方式
//单行注释
/*
多行注释
*/
/**
文档注释
*/
开始的时候肯定很疑惑,文档注释是有什么作用呢,和多行注释只不过多了一个*号,有什么区别。其实,这个在编写帮助文档的时候有着重要的作用。
我们查看帮助文档的时候,都会发现:
其实这些都是在编写文档的时候在文档注释中写入的东西。
接下里我们来做一个可以制作帮助文档的代码例子。其实是我的另一篇讲工具类的博客啦。
类有类的文档:
/**
* 该类是进行数组操作的一个工具类
* @author 好吃的都给你呀
* @since 2019-11-01
* @version jdk1.8
*
*/
public class ArrayTool{
方法的文档:
/**
* 该方法用于找出数组元素中的最大值
* @param arr 用于求最大值的数组
* @return 返回数组元素中的最大值
*/
//求数组中最大值
public static int Max(int[] arr) {
int max = 0;
for(int i =0;i<arr.length;i++) {
if(arr[i]>max)
max = arr[i];
}
return max;
}
在我们进行编写的时候在类或者方法的上面 先键入 /**然后回车(我用的是Eclipse),会自动生成完整格式和一些提示符。除了第一行用来书写该类或者方法的作用,其他的还可以用 @关键字 比如:@author 或者 @return 来进行关键信息的输入和收集。
完整代码为:
/**
* 该类是进行数组操作的一个工具类
* @author 好吃的都给你呀
* @since 2019-11-01
* @version jdk1.8
*
*/
public class ArrayTool{//这里记得让类是公共的
//遍历数组元素
/**
* 该方法用于数组元素的遍历输出,格式为:[元素1,元素2,...].
* @param arr 进行遍历的数组
*
*/
public static void traverse(int[] arr) {
System.out.print("[");
for(int i = 0;i<arr.length-1;i++) {
System.out.print(arr[i]+",");
}
System.out.println(arr[arr.length-1]+"]");
}
/**
* 该方法用于找出数组元素中的最大值
* @param arr 用于求最大值的数组
* @return 返回数组元素中的最大值
*/
//求数组中最大值
public static int Max(int[] arr) {
int max = 0;
for(int i =0;i<arr.length;i++) {
if(arr[i]>max)
max = arr[i];
}
return max;
}
/**
* 该方法用于找出数组元素中的最小值
* @param arr 用于求最小值的数组
* @return 返回数组元素中的最小值
*/
//求数组最小值
public static int Min(int[] arr) {
int min = 10000;
for(int i =0;i<arr.length;i++) {
if(arr[i]<min)
min = arr[i];
}
return min;
}
/**
* 该方法用于交换两个位置上的元素
* @param arr 交换元素的数组
* @param x 索引x
* @param y 索引y
* @return 返回改变元素之后的数组
*/
//交换数组中两个位置的元素
public static int[] swap(int[] arr,int x,int y) {
int temp = arr[x];
arr[x] = arr[y];
arr[y] = temp;
return arr;
}
/**
* 该方法用于反转数组
* @param arr 用于反转的数组
* @return 返回反转之后的数组
*/
//反转数组
public static int[] reverse(int[] arr) {
for(int i = 0;i<arr.length/2;i++) {
swap(arr,i,arr.length-i-1);
}
return arr;
}
}
这时,我们完成了工具类的编写和文档注释的编写,就可以来进行帮助文档的生成了。
选中上述箭头所指选项。
接下来:
然后就好啦。
然后我们再去打开我们事先准备好的文件夹。
打开index文件,就可以看到我们的API了。
点击进去:
然后看下边:
然后随便点进去一个:
这些参数都是我们事先写入的。
到这里,我们的API已经制作并检验完毕啦。
下面是第二种方法:
第二种是利用Dos命令来进行制作:
小提示:Eclipse 中在Alt+Enter 可以查看当前文件的状态信息,当然,最主要的是查看他的保存路径。
这就也制作完成啦,和在Eclipse中效果是一样的。
下一篇: 如何安装MongoDB
推荐阅读
-
帮助文档的使用和制作
-
API帮助文档的使用、Scanner类、Random类、ArrayList 类
-
Gson使用文档(集合必须是带泛型的,从而必须用new TypeToken,匿名类,getType())...
-
使用POI和DynaBean导出Excel的完整例子 ExcelApacheSQLStrutsBean
-
使用POI和DynaBean导出Excel的完整例子 ExcelApacheSQLStrutsBean
-
数据结构二分法-给定一个排序数组和一个目标值,在数组中找到目标值,并返回其索引。如果目标值不存在于数组中,返回它将会被按顺序插入的位置。 请必须使用时间复杂度为 O(log n) 的算法。
-
使用Eclipse和JUnit开发简单的单元测试
-
android开发,volley的二次封装和使用
-
不使用循环递归的方式求1~n的和
-
Java不使用循环的方式求1~n的和