java说明文档的制作

       有些时候我们会把常用的函数封装成类，编译成.class文件，给别人使用，但别人不知道这个类有哪些方法该如何如何调用，此时我们需要做一个类的说明文档：采用在.java类里面进行注释，通过注释来生成类的说明文档的方法。

一、注释的写法：

注释用/**开始，*/作为结尾。

@author   作者

@version   版本

@param  arr   传入的值   （arr是方法参数的名称，“传入的值”是对参数名的说明）

@return   返回的值  （返回什么这里填写什么，“返回的值”是对返回值的说明）

trans.java：

/**
 * 此类用于给数组排序，求最值
 * @author aaa
 * @version 1.0
 */
public class trans {
	public trans()
	{
		
	}
	/**
	 * 给int数组进行选择排序
	 * @param a  传入一个数组
	 */
	public static void ssort(int []a)
	{
		for(int i=0;i<a.length-1;i++)//控制循环次数 
		{
			for(int j=i+1;j<a.length;j++)
			{
				if(a[i]>a[j])
				{
					int t=a[i];
					a[i]=a[j];
					a[j]=t;
				}
			}
		}
	}
	/**
	 * 求一个int数组的最大值
	 * @param arr 传入一个int数组
	 * @return 返回一个int