帮助文档的制作javadoc

将自己写的工具类Tool的Tool.class文件发送给其他人,其他人只要将该文件设置到classpath路径下,就可以使用该工具类。

但是很遗憾,该类中到底定义了多少个方法,对方却不清楚,因为该类并没有使用说明书。

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

/**

.............

@ author joan

@ version v1.1

*/

/**

@ param arr 数组

@ return ............

*/

用类似这样的格式来给Java文件注释。

Javac -d myhelp -author -version javac Tool.java

1.需要bin目录下的javadoc.exe工具,对该文档进行提取并形成说明书。

2.这里我们把建好的Tool.java放到D盘的java目录下。

3.----->cmd----->javac----->D:------>cd java------>javac Tool.java

进入D盘的java目录下,编译Tool.class文件。

4.javadoc -d myhelp -author -version javac Tool.java

对该文档进去提取并形成说明书。

在D盘java目录下,生成文件名为myhelp的说明书,可以显示版本、作者。

-d  --->就是在dir路径

-dc  ---->也可以指定说明书生成的位置,例如,在C盘。

5.发给其他人用是,就只要有Tool.class和说明书就可以了,给Tool.class配置环境变量。

时间: 2024-07-28 16:17:22

帮助文档的制作javadoc的相关文章

java 帮助文档的制作javadoc

调用命令: javadoc -d doc -author -version -encoding UTF-8 -charset UTF-8 *.java -d:帮助文档生成后存放的目录 -author:在帮助文档中加入作者 -version:帮助文档中加入版本号 一个类中默认会有一个空参数的构造函数,这个默认的构造函数的权限和所属类一致. 如果类被public修饰,默认构造函数也带public修饰,如果类没有被public修饰,默认构造函数也没有public修饰. 默认构造函数的权限随着类的变化而

Java-帮助文档的制作

Java-帮助文档的制作 1,public修饰的类才可以用bin/javadoc生成文档 2,java的说明书是通过文档的注释来完成的,所以在写程序的时候,注释是很有必要的 使用文档注释法,才可以生成文档 /** */ 3,顺便介绍几个常用的数组方法 交换 格式化打印,可以自定义格式 获取最大值 获取最小值 冒泡排序 选择排序 4,利用DO命令行生成 打开myhelp文件夹,打开index.html索引目录即可 版权声明:欢迎交流,QQ872785786

【VC编程技巧】窗体?3.5对单文档或者多文档程序制作启动画面

(一)概要: 文章描述了怎样通过Visual C++ 2012或者Visual C++ .NET,为单文档或者多文档程序制作启动画面.在Microsoft Visual Studio 6.0中对于单文档程序(SDI)我们可以很方便利用微软提供的组件Visual C++ Component (Splash Screen).因为在Microsoft Visual Studio 6.0以后的版本或者Visual C++ .NET没有提供这个组件,我们可以通过自定义对话框来实现Splash Screen

使用文档注释(javadoc)

相信作为Java程序猿,几乎每个人都使用过javac,Java这样的命令吧.想想我们平时使用的Java帮助文档(API),感觉挺好用的,其实它就是使用Java中的命令javadoc做成的.下面简单介绍一下这个命令是怎么使用的: 首先Java中用三种注释方式,要想使用javadoc生成文档并且将注释信息也添加进文档里面,就要是用这种方式: 1 /** 2 * 3 */ 其次就是注释信息应该放置的位置.1.对类的注释放在类申明之前;2.对方法的注释放在方法申明之前;下面举一个简单的例子: 1 pac

chm开源文档制作

作为开发人员,API文档是非常关键的^_^,但是很多时候官方提供的文档是html的docs,不方便于携带查询,本章主要介绍chm文档的制作方法. 使用jd2chm制作chm文档 安装之前必须先安装 htmlhelp.exe,将jd2chm.exe复制到docs文档下的index.html入口文件同级目录下,然后进入cmd命令行到该目录下运行jd2chm.exe即可(也可以直接双击运行java2chm.exe,但是这样的话如果中途出错将会闪退,不好排查错误),成功后,即在当前目录下生成*.chm.

帮助文档chm的制作

帮助文档有多重要,用户会不会用,站在用户的角度去用易懂的文字书写解说你的产品.无意间回想起当初学C/S的时候,在导师的介绍下实践过chm帮助文档的制作.现在回想起 又一片空白.找了一篇文档看了下.更新下封存的记忆.写下来.有需要的时候用: 文档地址:http://jingyan.baidu.com/article/aa6a2c143117530d4d19c45e.html

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

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

度量快速开发平台中制作帮助文档实现介绍

度量快速开发平台中,构建的业务系统,在交给客户使用的时候,一般是需要制作客户使用帮助文档.因为度量快速开发开发平台是集成了C/S,B/S的整合平台,可以很方便的利用html文档来制作业务系统帮助文档.示例:---------------------------------------------------------------------------------------------------------------------主网页:helpIndex.htm<html><he

Java在DOS命令下的运行及其API文档制作过程

该文档主要描述java程序在DOS命令下的运行,以及一些常用的命令 常用DOS命令: d: 回车 盘符切换 dir(directory):列出当前目录下的文件以及文件夹 md (make directory) : 创建目录 rd (remove directory): 删除目录 cd (change directory)改变指定目录(进入指定目录) cd.. : 退回到上一级目录 cd\: 退回到根目录 del (delete): 删除文件,删除一堆后缀名一样的文件*.txt exit : 退出