面向对象(java文档说明书)
1、面向对象(帮助文档的制作javadoc)
假设，把ArrayTool.class存放到C盘的目录下。把它变成了一个工具。见图1.
然后就写个ArrayToolDemo.java。
class ArrayToolDemo
{
public static void main(String[] args)
{
int[] arr={3,1,87,32,8};
int max=ArrayTool.getMax(arr);
system.out.println("max="+max);//同样也是打印max=87;
}
编译时错误。找不到ArrayTool.class。调用不了ArrayTool的类中的内容。见图2
那么就可以设置环境变量。classpath=c:\myclass编译通过。但运行错误。见图3.
再次修改环境变量。classpath=.;c:\myclass代表即包括了原来配置好的环境变量，还包括了当前目录下的环境变量。编译运行通过。见图4.
接下来，将ArrayTool.class文件发送给其他人，而其他人是要将该文件设置到classpath路径下，就可以使用该工具类。
但是，很遗憾，该类中到底定义了多少个方法，对方却不清楚，因为没有该类的说明书。
开始制作程序的说明书。java的说明书通过文档注释来完成。
/**
这是一个可以对数组进行操作的工具类，该类中提供了，获取最值，排序等功能。
@author zhangsan
@version V1.1
*/
class ArrayTool
{
/**
获取一个整型数组最大值
@param arr 接受一个int类型的数组。
@return 会返回一个该数组中最大值。
*/
public int getMax(int[] arr)
{
...
}
/**
获取一个整型数组最小值
@param arr 接受一个int类型的数组。
@return 会返回一个该数组中最小值。
*/
public int getMin(int[] arr)
{
...
}
/**
给一个int数组进行选择排序。
@param arr 接受一个int类型的数组。
*/
public int selectSort(int[] arr)
{
...
}
/**
给一个int数组进行冒泡排序。
@param arr 接受一个int类型的数组。
*/
public void bubbleSort(int[] arr)
{
...
}
/**
数组元素进行位置互换。
@param arr 接受一个int类型的数组。
@param a 要置换的位置。
@param b 要置换的位置。
*/
public void swap(int[] arr,int a,int b)
{
...
}
}
javadoc运行报错。见图5
public class ArrayToolDemo//把这个类文件暴露出去。用public
{
public static void main(String[] args)
{
...
}
编译通过。见图6
然后找到myhelp文件下的index.html。见图7
打开后，出现了下面的画面：见图8.
一个类中默认的会有一个空参数的构造函数。
这个默认的构造函数的权限和所属类一致。
如果类被public修饰，那么默认的构造函数，也没有public修饰符。
class Demo
{
Demo(){}//这是自定义构造函数，不是默认构造函数。
}
图9.就是所谓的API文件（API帮助文档）：application program （API）,应用程序接口。