Eclipse生成javadoc帮助文档及基础知识

时间:2021-02-10 09:34:29

前言:

1.生成的API文档是一个名为index.html的文件

2.javadoc只处理文档源文件在类,接口,方法,成员变量,构造器,内部类之前的注释,忽略掉其他地方的注释

3.javadoc工具默认只处理以public或protected修饰的类,接口,方法,成员变量,构造器,内部类前的文档注释

4.文档注释以两个型号(/**)开始,以星号后紧跟一个斜线(*/)结束,中间部分都是文档注释,会被提取到API文档中

5.常用javadoc标记:

@author:指定Java程序的作者

@version:指定源文件的版本

@deprecated:不推荐使用的方法

@param:方法的参数说明信息

@return:方法的返回值说明信息

@see:“参见”,用于指定交叉参考的内容

@exception:抛出异常的类型

@throws:抛出的异常,和@exception同义


用Eclipse生成javadoc文档:

1.打开java代码,编写JavaDoc 注释(尽量写的详细)

Eclipse生成javadoc帮助文档及基础知识

2.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项

Eclipse生成javadoc帮助文档及基础知识

3.

(1)选择要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

Eclipse生成javadoc帮助文档及基础知识

4

(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮


Eclipse生成javadoc帮助文档及基础知识

5.

(1)选择使用的jdk版本

(2)点击【Finish】按钮

Eclipse生成javadoc帮助文档及基础知识

6.项目下生成一个【doc】的目录,里面存放着javadoc文档