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

原创 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;

 

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

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

帮助文档(*.chm)制作 以及在winform程序中的应用

一、帮助文档制作 软件:Html help
  • shmily0923
  • shmily0923
  • 2014年08月27日 10:32
  • 1635

C# 如何生成CHM帮助文件

C# 如何生成CHM帮助文件     前一段时间应公司要求,让我开发一个数据库字段信息CHM帮助文件生成软件。结果当时我就二了,这个东西我只用过,不知道咋做啊。没想到老大很随意说一句:"没事,这...
  • moshansk
  • moshansk
  • 2016年02月16日 10:33
  • 2028

Doxygen C++注释规范及生成帮助文档配置步骤

Doxygen C++注释规范及生成帮助文档配置步骤 一、  C++风格的注释 1   概述 C++的注释风格主要使用下面这种样式:即在注释块开始使用三个反斜杠‘/’ 其他地方其实与JavaD...
  • liuyinghui523
  • liuyinghui523
  • 2014年05月06日 16:47
  • 1589

cmd命令对java程序进行编译时出现:“编码GBK的不可映射字符”两种解决方法,以及dos下帮助文档的制作

cmd命令对java程序进行编译时出现:“编码GBK的不可映射字符”两种解决方法,以及dos下帮助文档的制作...
  • benjamin_leung
  • benjamin_leung
  • 2017年12月27日 14:52
  • 38

制作帮助文档的小程序

  • 2009年07月28日 11:17
  • 4.51MB
  • 下载

程序帮助文档制作软件

  • 2009年04月24日 08:27
  • 3.61MB
  • 下载

Qt下创建应用程序的帮助文档

本文相关:利用Qt自身带有的Qt Assistant工具制作应用程序的帮助文档。 相关工具:qhelpgenerator、qcollectiongenerator、assistant。三个工具均在mi...
  • tianjueyiyi
  • tianjueyiyi
  • 2017年06月09日 09:57
  • 1118

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

iOS Sprite Kit教程之使用帮助文档以及调试程序
  • u014621518
  • u014621518
  • 2015年07月24日 11:06
  • 632

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

Android应用程序是由JAVA编写的。Android的SDK工具把编写好的应用程序代码连同一些数据和资源编译成一个.apk后缀的Android应用程序包。包含在同一个apk文件里面的所有代码就当成...
  • sam_zhang1984
  • sam_zhang1984
  • 2011年05月17日 16:53
  • 3321

关于利用Qt编写应用程序的帮助文档

转载请注明出处! 关于利用Qt编写应用程序的帮助文档 首先推荐Qt官网的example 官网的例子讲的很细致很全面,不过官网的例子全是英文的。百度文库里有对这个例子的翻译,我也看了一下,感...
  • changyanxiaoming
  • changyanxiaoming
  • 2013年08月30日 14:33
  • 1948
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:帮助文档的制作(程序说明书)
举报原因:
原因补充:

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