帮助文档的制作javadoc
2015-06-23 22:59
423 查看
将自己写的工具类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配置环境变量。
但是很遗憾,该类中到底定义了多少个方法,对方却不清楚,因为该类并没有使用说明书。
开始制作程序的说明书,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配置环境变量。
相关文章推荐
- java学习之旅11--【补充】JDK7新特性_二进制整数_下划线分隔符
- Java编程思想学习---第二天
- Java Web中转向问题
- Java类的加载及初始化
- java学习之旅10--基本数据类型自动转换_强制转型_类型提升问题
- springMVC获取传递的参数
- java exception 详解
- Java中对象JSON格式化处理时的一个坑
- 11.Eclipse安装了genymotion 没有图标显示?
- Java基础之多线程2
- Java 时间测量、耗时计算方法
- HDU 3887 Counting Offspring(DFS序求子树权值和)
- Spring MVC+Quartz 定时任务持久化
- 一个在JSP页面上使用JavaBean的例子
- java 如何跳出指定的for循环
- Java 自动装箱与拆箱(Autoboxing and unboxing)
- eclipse中 Android SDK Manager 图标不见了
- Java格式输出
- Spring MVC JSR303数据校验
- JavaFx自定义窗体