什么是javadoc

一、javadoc
javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

二、语法

      所有javadoc命令都只能在"/**"注释中出现，以"*/"结束。使用javadoc的方式主要有两种：嵌入html或是“文档标签”。独立文档标签是一些以"@"字符开头的命令，且要置于注释前的最前面，而行内文档标签则可以出现在javadoc注释的任何地方，也是以“@”开头，但要扩在花括号内。

      共有三种类型的注释文档，分别对应于注释文职后面的三种元素：类、域、方法。类注释正好位于类定义之前，域注释正好位于域定义之前，而方法注释位于方法定义之前。例：

/** A class comment /
public class Demo
{
/* A field comment /
public int i;
/* A method commend */
public void f(){}
}

三、一些文档标签
@author 标识一个类的作者 @author description
@deprecated 指名一个过期的类或成员 @deprecated description
{@docRoot} 指明当前文档根目录的路径 Directory Path
@exception 标志一个类抛出的异常 @exception exception-name explanation
{@inheritDoc} 从直接父类继承的注释 Inherits a comment from the immediate surperclass.
{@link} 插入一个到另一个主题的链接 {@link name text}
{@linkplain} 插入一个到另一个主题的链接，但是该链接显示纯文本字体 Inserts an in-line link to another topic.
@param 说明一个方法的参数 @param parameter-name explanation
@return 说明返回值类型 @return explanation
@see 指定一个到另一个主题的链接 @see anchor
@serial 说明一个序列化属性 @serial description
@serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据 @serialData description
@serialField 说明一个ObjectStreamField组件 @serialField name type description
@since 标记当引入一个特定的变化时 @since release
@throws 和 @exception标签一样. The @throws tag has the same meaning as the @exception tag.
{@value} 显示常量的值，该常量必须是static属性。 Displays the value of a constant, which must be a static field.
@version 指定类的版本 @version info

四、使用方法
在eclipse中，选中java文件，右键选择Export，进入Export界面，选Java-Javadoc

然后连续两次电Next，输入-encoding utf-8 ，点击Finish

就可以看到html正在生成

最后可在文件夹里点开html查看javadoc