帮助文档的制作(程序说明书)

原创 2015年07月09日 20:21:43

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

先注释

/**
这是一个可以对数组进行操作的工具类,该类中提供了:获取最值,排序等功能;
@author 刘明
@version V1.123
*/

pulic class ArrTool//必须用public修饰
{
	/**
	空参数构造函数
	*/
	private ArrTool(){}
	/**
	获取一个整型数组中的最大值、
	@param(参数)  arr 接收一个int类型的数组//(参数)是方便此次阅读,制作时不能写,一写就报错;
	@return 会返回一个该数组的最大值
	*/
	public static int Getmax(int[] arr)
	{
		int max=0;
		for(int x=0;x<arr.length;x++)
		{
			if(arr[x]>arr[max])
				max=x;
		}
		return arr[max];
	}
	/**
	获取一个整型数组中的最小值、
	@param(参数)  arr 接收一个int类型的数组
	@return 会返回一个该数组的最小值
	*/
	public static int Getmin(int[] arr)
	{
		int min=0;
		for(int x=0;x<arr.length;x++)
		{
			if(arr[x]<arr[min])
				min=x;
		}
		return arr[min];
	}
	/**
	给数组进行选择排序
	@param(参数)  arr 接收一个int类型的数组
	*/
	public static void SelectSort(int[] arr)
	{
		for(int x=0;x<arr.length-1;x++)
		{
			for(int y=x+1;y<arr.length;y++)
				if(arr[x]>arr[y])
			{
				Swap(arr,x,y);
			}
		}
	}
	/**
	给数组进行冒泡排序
	@param(参数)  arr 接收一个int类型的数组
	*/
	public static void BubbleSort(int[] arr)
	{
		for(int x=1;x<arr.length-1;x++)
		{
			for(int y=0;y<arr.length-x;y++)
			{
				if(arr[y]>arr[y+1])
					Swap(arr,y,y+1);
			}
		}
	}
	/**
	给数组中的元素进行位置置换。
	@param arr 接收一个int类型的数组。
	@param a  要置换的位置。
	@param  b  要置换的位置。
	*/
	private static void Swap(int[] arr,int a,int b)
	{
		int t=arr[a];
		arr[a]=arr[b];
		arr[b]=t;
	}
}


调用javadoc  

-d表示保存到文件夹,后面跟文件夹地址,myhelp,如果当前目录没此文件夹则会自动创建,当然也可以创建在C盘(C:\myhelp);

-author -version 时显示作者和版本的,可写可不写,根据自己要求;

按下Enter

然后发现目录下出现

点进去出现一大串网页

打开index.html;

 

这样程序说明书就 完成了;

版权声明:本文为博主原创文章,未经博主允许不得转载。

相关文章推荐

iOS Sprite Kit教程之使用帮助文档以及调试程序

iOS Sprite Kit教程之使用帮助文档以及调试程序

Android帮助文档翻译——开发指南(一)应用程序基本原理

Android应用程序是由JAVA编写的。Android的SDK工具把编写好的应用程序代码连同一些数据和资源编译成一个.apk后缀的Android应用程序包。包含在同一个apk文件里面的所有代码就当成...

Discuz二次开发 教你识别程序目录和文件列表 - 帮助文档

作为一款以社区为基础的专业建站平台,Discuz! X1社区平台系统让论坛(BBS)、社交网络(SNS)、门户(Portal)、群组(Group)、开放平台(Open Platform)充分融合于一体...

制作帮助文档的小程序

  • 2009-07-28 11:17
  • 4.51MB
  • 下载

doxygen+htmlhelpworkshop制作帮助文档

最近在弄ACE,想看类的结构很麻烦,网上的chm文档好难找, 官网的帮助手册为:http://www.dre.vanderbilt.edu/Doxygen/6.2.0/html/libace-doc/...

程序帮助文档制作软件

  • 2009-04-24 08:27
  • 3.61MB
  • 下载

Java文如何制作帮助文档4

------- android培训、java培训、期待与您交流! ---------- 如何制作帮助文档: (1)写一个类 (2)加入文档注释 (3)通过javadoc工具生成即可 javadoc ...

制作CHM帮助文档

原创作品,允许转载,转载时请务必以超链接形式标明文章 原始出处 、作者信息和本声明。否则将追究法律责任。http://zhoufoxcn.blog.51cto.com/792419/166049 ...
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:深度学习:神经网络中的前向传播和反向传播算法推导
举报原因:
原因补充:

(最多只允许输入30个字)