使用工具:
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~");
}
}