静态的应用、工具类和程序的说明书制作

开始制作程序的说明书

java的说明书通过文档注释来完成。以静态应用为例。

静态的应用

每一个应用程序中都有共性的功能，可以将这些功能进行抽取独立封装以便复用。
虽然可以通过建立ArrayTool的对象使用这些工具方法，对数组进行操作，发现一个问题
1、对象是用于封装数据的，可是ArrayTool对象并未封装特有数据
2、操作数组的每一个方法都没有用到ArrayTool对象中的特有数据
这时就考虑，让程序更严谨，是不需要对象的，可以将ArrayTool中的方法都定义成静态的，直接通过类名调用即可。
将方法都静态后，可以方便于使用，但是该类还是可以被其他程序建立对象的。为更为严谨，强制让该类不能建立对象，可以通过将构造函数私有化
接下来将ArrayTool.class文件发送给其他人，其他人只要将该文件设置到classpath路径下，就可以使用该工具类了
但是，很遗憾，该类中到底定义了多少个方法，对方却不清楚，因为该类并没有使用说明书。

开始制作程序的说明书。java的说明书通过文档注释来完成。

	/**
	给数组中的元素进行位置的置换
	@param arr 接受一个int类型的数组
	@param a 要置换的位置
	@param b 要置换的元素
	*/
	private static void swap(int[] arr,int a,int b)
	{
		int temp=arr[a];
		arr[a]=arr[b];
		arr[b]=temp;	
	}

	/**
	用于打印数组中的元素，打印形式是：[element1,elment2...]
	*/
	public static void printArray(int[] arr)
	{
		System.out.println("[");
		for (int i=0;i<arr.length-1 ;i++ )
		{
			if(i!=arr.length-1)
				System.out.println(arr[i]+", ");
			else
				System.out.println(arr[i]+"]");
		}
	}
}

文档注释类必须是public的 dos命令编译如下：javadoc -d myhelp -author -version ArrayTool.java

注意事项：

• 一个类中默认会有一个空参数的构造函数
• 这个构造默认构造函数的权限与所属类一致
• 如果类被public修饰，那么默认的构造函数也带public修饰符
• 如果类没用被public修饰，那么默认构造函数，也没有public修饰
• 默认构造函数的权限是随着类的变化而变化的