使用工具：

jdk中的javadoc

实现步骤：

1、将java文件放到一个目录之下

2、进入doc(win+R,输入cmd)

3、通过cd指令进入存放java文件的文件夹

4、编译java文件

代码实现：

javac HelloWorld.java

注：

（1）这里如果报如下错的话，使用notepad++将编码格式改成ANSI编码（改编码格式之前先复制好代码）

（2）必须将类设置为public格式，因此类名和文件名必须一样，否则报如下错误

5、调用javadoc

代码实现：

javadoc -d helloWorldDoc HelloWorld.java

注：

（1）该语句是在本文件夹下新建一个helloWorldDoc文件夹来存放说明文档

（2）如果黑框中如图所示，即为生成成功

6、打开doc文档、并打开index.html,如下图，即为说明文档

注：

（1）注意这一句，对比一下源码，正是代码中文档注释的内容，注意文档注释（开头两个*）和块注释（开头一个*）功能大体相同，但是只有文档注释中的内容可以被Javadoc给扫到，所以常常用来给类、方法添加说明。

/**
这是一个生成helloworld的类
*/
public class HelloWorld{public static void main(String args[]){System.out.println("hello world~");}
}

【java】将自己写的类生成说明文档的方法相关推荐

Eclipse用法和技巧四：生成说明文档1
写代码经常要添加注释的,java代码的注释也可以分为两种.单行注释以"//"作为开头就可以.段落注释在第一行开头添加"/*",在最后一行结尾添加"*/ ...
pydoc自动生成说明文档及常见问题解决
pydoc是python自带的一个文档生成工具,pydoc可以直接生成html.md的说明文档,也可以启动本地服务,在web上查看文档. 关于html的样式是下面这种形式. 对于常见的类似下面这种样式 ...
Eclipse用法和技巧五：生成说明文档2
上面一篇文章里面我们介绍了一种生成可以被JDK提取到,生成JavaDoc的添加注释方法.下面再补充一种生成这种注释的方法,上图: 步骤一:光标移动到需要添加注释的语句旁边,快捷键:shift + al ...
[转]如何写一份交互说明文档
转载请注明来处,关注我,请点击:http://weibo.com/heidixie 离开交互圈已经有段时间了.但由于博客还在,还是能够偶尔收到一些邮件,上周有位同学问我:我在求职,我看到很多招聘说明上 ...
java飞机大战流程图_飞机大战说明文档
JIANGXI AGRICULTURAL UNIVERSITY精彩内容,尽在百度攻略:https://gl.baidu.com 科技月月评设计报告精彩内容,尽在百度攻略:https://gl.bai ...
怎么生成a类型的对象 java_用一个 java 程序！写一个类A, 该类创建的对象可以调用方法f输出英文字母表，然后再编写...
展开全部 class A:public static void f(){ int firstEnglish, lastEnglish; char firstE = 'A', lastE = 'Z'; ...
Java中使用UUID工具类生成唯一标志防止重复
场景 UUID 是指Universally Unique Identifier,翻译为中文是通用唯一识别码,UUID 的目的是让分布式系统中的所有元素都能有唯一的识别信息. 在某些场景下需要给数据库中 ...
java 用映射写工厂类_java23种设计模式——三、工厂模式
目录工厂模式工厂模式介绍工厂模式是我们最常用的实例化对象模式了,是用工厂方法代替new操作的一种模式.著名的Jive论坛 ,就大量使用了工厂模式,工厂模式在Java程序系统可以说是随处可见.因为 ...
java导出csv文件_java导出生成csv文件的方法
本文实例为大家分享了java导出生成csv文件的具体代码,供大家参考,具体内容如下首先我们需要对csv文件有基础的认识,csv文件类似excel,可以使用excel打开,但是csv文件的本质是逗号分 ...

【java】将自己写的类生成说明文档的方法

使用工具：

实现步骤：

【java】将自己写的类生成说明文档的方法相关推荐

最新文章

热门文章