Eclipse 下 javadoc 的使用

Javadoc：用于提取注释的工具。是jDK安装的一部分。输出是HTML文件。

注释方法：/**     注释的内容     */

使用javadoc的两种方式：

1.嵌入HTMl:

 例如：

/**

 * <pre>

 * 实现.....的功能方法

 *</pre>

 */

 注意：不要在嵌入的html中使用标题标签，例如：<h1></h1>,因为javadoc会插入自己的标题，自己添加的标题标签可能会和它发生冲突

2.使用文档标签：

例如：

/**

 * @author xiyuan ---作者相关信息

 * @deprecated ---指出一些旧特性已由新特性所取代，建议用户不要使用这些旧特性

 * @see  classname----（引用其他类的文档）

 * @since 指定程序代码最早使用的版本（java文档中用于指定JDK的版本情况）

 * @version version 1.0 ----（版本信息）

 * {@docRoot}----产生到文档根目录的相对路径

 * {@link}----与@see相似，只是用于行类

 */

还有几种常用标签：

@param：用于方法文档，说明参数的意义

@return：用于方法文档，说明返回值含义

 

3种类型的注释文档：类注释、域（变量）注释、方法注释。

注意：只能为public、protected成员进行文档注释

 

使用方法：

第一步：点击project->Generate javadoc   弹出以下界面

下一步

下一步