Java如何制作帮助文档(API)

Java如何制作帮助文档(API)

步骤如下：
　　(1)写一个工具类
　　(2)对这个类加入文档注释
　　(3)用工具解析文档注释
　　　　javadoc工具
　　(4)格式
　　　　javadoc -d 目录 -author -version ArrayTool.java

　　制作帮助文档(API)出错问题解决：
　　　　找不到可以文档化的公共或受保护的类
　　　　　　这句话告诉我们对想要操作的类的权限不够。在类前面加上public即可。
如下图所示02：


---------------------------------------
　　将来做开发的时候，我们给别人的东西就是Xxx.class文件和帮助文档(API)。别人通过帮助文档(API)来使用Xxx.class文件。
　　这就是面向对象思想，我才不管你是怎们实现的呢！我满足你的条件会用就可以。

原文地址：https://www.cnblogs.com/chenmingjun/p/8447349.html

时间： 2024-10-06 10:07:21

Java如何制作帮助文档(API)的相关文章

java如何使用帮助文档api

1:打开帮助文档2:点击显示,找到索引,看到输入框3:知道你要找谁?以Scanner举例4:在输入框里面输入Scanner,然后回车5:看包 java.lang包下的类不需要导入,其他的全部需要导入. 要导入: java.util.Scanner6:再简单的看看类的解释和说明,别忘了看看该类的版本7:看类的结构 成员变量→ 字段摘要 构造方法→ 构造方法摘要 成员方法 →方法摘要8:学习构造方法 A:有构造方法 就创建对象 B:没有构造方法 成员可能都是静态的9:看成员方法 A:左边 是否静态:

javadoc简易数组工具类文档(API)

制作简易数组工具类文档(API) 如何创建文档 以数组工具类(Array)为例一丶创建一个数组工具类  要求实现(1)遍历数组(2)求数组中的最大值(3)查询数组中的元素在数组中第一次出现的索引(4)将数组元素翻转并遍历 /** * 这是数组的一个工具类 * @author Apple * @version V1.0 * */ public class Array{  private Array(){ //将无参构造私有化,无法实例化  }    /**遍历数组  * @param arr :需

反射机制--调用构造函数和成员方法、制作帮助文档

今天学习了关于反射的相关知识,通过反射可以找到类中的构造方法和所有的成员方法.而并不了解这个类的构造的人可以很方便的运用反射机制. 掌握发射主要了解这几个类,类位于java.long.reflect包中: Class类:代表一个 类 Constructor类:代表累的构造方法 Field类:代表类中的成员变量 Method类:代表类的方法 import java.lang.reflect.*; /** 这是一个反射机制的例子实例,包括如何利用反射找到无参.有参的构造方法,以及其他方法. @aut

org.w3c.dom(java dom)解析XML文档

位于org.w3c.dom操作XML会比较简单,就是将XML看做是一颗树,DOM就是对这颗树的一个数据结构的描述,但对大型XML文件效果可能会不理想 首先来了解点Java DOM 的 API:1.解析器工厂类:DocumentBuilderFactory 创建的方法:DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); 2.解析器:DocumentBuilder 创建方法:通过解析器工厂类来获得 DocumentBu

利用Java动态生成 PDF 文档

利用Java动态生成 PDF 文档,则需要开源的API.首先我们先想象需求,在企业应用中,客户会提出一些复杂的需求,比如会针对具体的业务,构建比较典型的具备文档性质的内容,一般会导出PDF进行存档.那么目前最佳的解决方案,你可能会想到 iText ,对没错... iText+(Velocity / Freemarker)可以实现.不过据我熟悉,iText本身提供的HTML解析器还是不够强大,许多HTML标签和属性无法识别,更悲催的是简单的CSS它不认识,排版调整样式会让你头大的.不要失望,接下来

PHP制作pdf文档方法

本篇博客是在看完 php+mysql web书以后自己的测试代码,虽然是测试代码,但不是简单的粘贴复制,为了学习thinkPHP框架,自己就用这个来做的,而且这本书已经有年头了.原书的代码中的方法,在查阅手册的时候,很多都已经弃用了,所以分享给大家还是有必要的.php制作pdf文档的方法有很多,我写的只是其中一种,大家有时间可以多看看.好了,进入正题 准备工作: 1.php手册(在线php关于pdf地址: http://php.net/manual/zh/intro.pdf.php ) 2.PD

关于如何利用Pocket CHM Pro制作帮助文档

关于如何利用Pocket CHM Pro制作帮助文档 编写人:CC阿爸 2015-4-6 今天在这里,我想与大家一起分享如何利用Pocket CHM Pro制作软件系统的帮助文档,在此做个小结,以供参考.有兴趣的同学,可以一同探讨与学习一下,否则就略过吧.   1. 首先给大家看看我制作好后的帮助文档.   如何还算漂亮吧.很多代码在里面,很方便查阅. 2. 下面我们就看看如何利用这个工具制作自己满意的帮助文档 1)         首先大家可以在我们的技术群中,找到该软件. 2)       

zedboard zynq 学习 sobel 边缘检测 IP核 制作 根据 文档 Xapp890

官方文档http://www.xilinx.com/support/documentation/application_notes/xapp890-zynq-sobel-vivado-hls.pdf 准备工作 下载 工程文件 http://pan.baidu.com/s/1eQqwjBk 这是我用百度云分享的 如果不行了, 可以用 官方链接 https://secure.xilinx.com/webreg/clickthrough.do?cid=193509 sobel 算子边缘检测原理 这里不

Java模拟实现百度文档在线浏览

Java模拟实现百度文档在线浏览 这个思路是我参考网上而来,代码是我实现. 采用Apache下面的OpenOffice将资源文件转化为pdf文件,然后将pdf文件转化为swf文件,用FlexPaper浏览. ok, A.下载OpenOffice (转换资源文件) B.下载JodConverter(调用OpenOffice) C.下载Swftools(Pdf2Swf) D.下载 FlexPaper(浏览swf文件) 这里我已经全部下载好了,大家只需要下载:http://down.51cto.com