Java文如何制作帮助文档4

原创 2015年07月07日 07:41:01

 

如何制作帮助文档:

(1)写一个类
(2)加入文档注释
(3)通过javadoc工具生成即可

javadoc -d 目录 -author -version ArrayTool.java

ps.

输入后会自动如果原文件中没有myhelp文件夹,会自动生成一个myhelp文件夹

从名称为  index.html索引页面开始观看。

会发现并无换位操作,私有的不提取,属于被保护权限

只有两种权限会在其中出现public   protect


为什么使用帮助文档?

静态的应用。


每一个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装,以便复用,

 

虽然可以通过建立ArrayTool的对象使用这些工具方法,对数组进行操作

发现问题:

1,对象是用于封装数据的,可是ArrayTool对象并未封装特有数据,

2,操作数组的每一个方法都没有用到ArrayTool对象中的特有数据。

 

这时就考虑,让程序更严谨,是不需要对象的,可以将ArrayTool中的方法都定义成static的,直接通过类名调用即。

 

将方法都静态后,可以方便与使用,但是该类还是可以被其他程序建立对象的,

为了更为严谨,强制让该类不能建立对象。可以通过将构造函数私有化完成,

 

接下来,将ArrayTool.class文件发送给其他人,其他人只要将该文件设置到classpath路径下,就可以使用该工具类,

但是,很遗憾,该类中到底定义了多少个方法,对方不清楚,因此需要使用说明书。

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


示例:

/**
这是一个可以对数组进行操作的工具类,该类中提供了,获取最值,排序等功能。
@author lp
@version v1.1
*/

public class ArrayTool 
{
	/**
	空参数构造函数。
	*/
	private ArrayTool(){}
	/**
	获取一个整形数组中的最大值。
	@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];
	}
	
	/**
	给int数组进行选择排序。
	@param arr 接收一个int 类型的数组。
	*/



第一步:通过javadoc工具生成即可

javadoc -d 目录 -author -version ArrayTool.java






第二步:点击index.html即可得到说明文档:





  

Java-帮助文档的制作

Java-帮助文档的制作 1,public修饰的类才可以用bin/javadoc生成文档 2,java的说明书是通过文档的注释来完成的,所以在写程序的时候,注释是很有必要的 使用文档注释法,才可...

黑马程序员 Java(二)>ArrayTool工具类以及帮助文档的制作<

---------------------- ASP.Net+Android+IO开发S、.Net培训、期待与您交流! ---------------------- ArrayTool工...

黑马程序员-----java帮助文档的制作

------- android培训、java培训、期待与您交流! ---------- java帮助文档的制作 凡是public修饰符修饰的方法都应用文档注释的方法注释,都可以被文档注释工具所提取...

Java基础——Static修饰符+静态相关+帮助文档制作+对象初始化_调用成员过程+单例设计

一、Static修饰符 String name;//成员变量,实例(对象)变量。 Static String name;//静态的成员变量,类变量。 用于修饰成员(变量,函数) 当每个对象都有...

使用javaHelp制作java swing帮助文档

 最近在做一个Swing项目,项目接近尾声,需要做最后的帮助系统了。简单搜索了一下,找到了javaHelp。JavaHelp是sun推出的编写帮助系统的一个类库,能够开发类似windows的CH...

Java-dom4j帮助文档

  • 2016年02月04日 20:24
  • 1.35MB
  • 下载

Java 中文帮助文档.part4

  • 2009年11月26日 00:16
  • 3.31MB
  • 下载

httpclient4 中文版帮助文档:第一章

import java.io.File; import java.io.IOException; import java.io.InputStream; import java.io.OutputSt...

java1.6.0帮助文档(中文版)4

  • 2007年12月07日 22:52
  • 28KB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:Java文如何制作帮助文档4
举报原因:
原因补充:

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