【Java】文如何制作帮助文档

如何制作帮助文档：

(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】文如何制作帮助文档相关推荐

8、Java如何制作帮助文档
1:如何制作帮助文档 (1)写一个类 (2)加入文档注释 (3)通过javadoc工具生成即可 javadoc -d 目录 -author -version A ...
【PDF】java使用Itext生成pdf文档--详解
[API接口] 一.Itext简介 API地址:javadoc/index.html:如 D:/MyJAR/原JAR包/PDF/itext-5.5.3/itextpdf-5.5.3-javadoc/i ...
利用javadoc制作API文档
要制作API文档,首先要保证代码中的文档注释无误,文档注释以[ /** ]开始,[ */ ]结尾,示例如下: package jtest; /** * Description: * <br/ ...
freemarker 制作word文档docx案例
主要用于生成特定word文档,需要替换docx中的文字,书签,图片,动态表格等本文以生成docx为例,doc文件目前有一些问题例如图片或模板不好处理等,暂不考虑. 思路: 1)熟悉docx文件的结 ...
JAVA eclipse(myeclipse)生成帮助文档（html或chm格式）
目录(?)[+] 转自:http://www.blogjava.net/lishunli/archive/2010/01/07/308618.html Javadoc转换chm帮助文档的四种方法总结 ...
java重新组合_Java 合并Word文档
在日常工作中,难免会遇到需要将多个Word文档合并到一个文档中,对其进行重新整理的情况,为了能帮助大家高效快速的完成这个操作,接下来本文就将介绍两种在Java程序中合并Word文档的方法. 方法一:如 ...
java流与文件——ZIP文档
[0]README 0.1) 本文描述转自 core java volume 2, 旨在理解 java流与文件--ZIP文档的相关知识: 0.2) for source code, please v ...
chm帮助文档编辑_零成本轻松制作帮助文档方法分享
要做一个软件或者网站,帮助文档是必不可少的一部分,没有帮助文档,用户遇到问题不知道该怎么解决,产品使用体验不好,可能导致放弃产品,或者找寻客服人员,客服工作压力大,离职率高,企业招人成本大大增加. 随 ...
OpenCV训练分类器制作xml文档
opencv 2.1网上查的另一种资料训练分类器成功,在此与大家分享. 参考英文资料网址: http://note.sonots.com/SciSoftware/haartraining.html# ...

【Java】文如何制作帮助文档

【Java】文如何制作帮助文档相关推荐

最新文章

热门文章