使用Eclipse生成javadoc帮助文档

代码撰写的最大问题，大概就是对文档的维护了，如果文档与代码是分离的，那么在每次修改代码的时候，都需要修改帮助文档，这将是一件非常乏味的事情。解决办法也很简单，就是生成帮助文档，将代码与文档链接起来。帮助文档的形式可以使che和HTML等多种，下面我们就来学习下使用Eclipse生成HTML的帮助文档。

我们使用Eclipse编写代码的时候，经常会出现一个这样的注释代码模板：

这个就是用来生成HTML帮助文档的。他是利用JDK的bin目录下的javadoc生成的。javadoc程序是专门用来生成帮助文档的一个程序。下面对javadoc命令进行一个简单的介绍：

语法：

所有的javadoc命令都只能在“/**”（这里注意，跟普通的注释有点区别的是这里的*号是两个）注释中出现，和通常的，注释结束于“*/”。使用javadoc的方式主要有两种：嵌入式HTML，或者使用“文档标签“。独立文档标签是以”@“字符开头的命令，且要置于注释行的最前面（紧接”*“之后，像Eclipse帮我们生成的格式一样）。而”行内文档标签“可以出现在javadoc注释中的任何地方,他们是以”@“字符开头，但要在花括号内。

可以注释的地方分为：域、类、方法。

域注释位于域定义之前，同样，类注释和方法注释也分别位于类和方法定义的前面。

注意：在private方法前面的注释会被忽略掉，除非用-private进行标记

嵌入式HTML

HTML和普通的HTML语法基本一样，不过不要在里面使用，因为javadoc会插入自己的标题。

标签示例

1. @see：引用其他类

2. {@link package.calss#member label}:与@see相似，但是他位于行内
3. {@docRoot}：改标签产生到文档根目录的相对路径，用于文档树页面的显示超链接。
4. {@inheritDoc}：改标签从当前这个类的最直接基类中继承相关文档到当前的文档注释中。
5. @version：说明版本信息。
6. @author：这个是比较常用的一个标签，用来说明作者。
7. @since：改标签允许你指定代码最早使用的版本。
8. @param：参数标签，这个也是比较常用的一个标签
9. @return：返回值标签
10. @throws：异常标签

示例

代码

首先编写代码，根据上面的语法写一个基本的Demo

流程图解

然后我们右击工程下的类文件，选择export导出。

 

找到java中的javadoc，也可以直接搜索

 

 

然后一路下一步，勾选你要生成哪些文件的帮助文档。

生成之后我们到项目路径src同级的doc目录下找到index.html，打开我们编译的文档就完成了，如图。