如将以下java源文件生成javadoc文档:
1 package com.javadoc;
2
3 /**这是一个类注释*/
4 public class JavaDocTest {
5
6 /**这是一个变量注释*/
7 private int value = 10;
8
9 /**这是一个方法注释*/
10 public void sayHello(){}
11 }
第一步:
如下图:点击工具栏的Project菜单选项,在弹出的框中选中Generate Javadoc选项并点击
第二步:
在第一步中点击Generate Javadoc选项弹出如下图所示界面。
在(1)处选择要生成javadoc文档的那个java源文件,
在(2)处选择哪些访问控制修饰符修饰的文档注释将输出在将要生成的javadoc文档中,默认为public,若选中private,则表示所有的文当注释内容都将输出在javadoc文档中。
在(3)处是选择要生成的javadoc文档的存放目录,一般选择默认存放目录,即在当前项目根目录下创建一个名为doc的文件夹,所有有关javadoc文档的的文件都会存放在doc文件夹下。
在(4)处是进入下一步。
第三步:
在(1)处,勾选上Document title选项,在此处填上该javadoc文档的文档标题
在(2)处点击进入下一步
第四步:
注意,
在(1)处填上黄色框中的内容(-encoding UTF-8 -charset UTF-8),可解决“编码GBK的不可映射字符问题”,如图1-1
在(2)处选择Jdk的版本,如图1-1
在(3)处点击finish完成,如图1-2:
图1-1
图1-2
第五步:
如下图,生成的javadoc文件就存放在该项目的根目录下的doc文件夹中,在浏览器中打开(2)处的index.html文件,就是生成的javadoc文档。