javadoc简介及用法

注释文档

文档和代码分离，在每次修改代码的时候，就需要修改相应的文档，解决的方法是将代码同文档“链接”起来，简单的方法是将所有东西放在同一文件。实现这一目的必须使用特殊的注释语法标记文档，此外需要工具提取注释，将其转化为有用的形式。
javadoc是用于提取注释的工具，查找程序内特殊注释的标签，不仅解析这些信息，也将毗邻注释的类名或方法名提取出来。javadoc输出是一个HTML文件，可用web查看，该工具使得我们只需创建和维护单一的源文件，自动生成有用的文档。

---

语法

所有的javadoc命令只能在“/**”注释中出现，注释结束于“*/”。
使用javadoc有两种方式：嵌入HTML，或使用“文档标签”。独立文档以@开头，位于注释行最前面。“行内文档标签”可出现在javadoc注释的任何地方，以@开头，括在花括号内。

共三种类型的注释文档，分别位于注释位置后面的三种元素：类、域、方法。

package test;
//: object/Document1.java

/** A class comment */
public class Document1 {
	/** A field comment */
	public int i;
	/** A method comment */
	public void f() {}
	public static void main(String[] args) {
	}
}///:~

java只能为公有、保护成员进行文档注释，私有和包内可访问成员被忽略（可以-private标记，以包括private成员的注释），因为public和protected成员在类外可使用，这是客户端成员期望的。上述代码输出结果是HTML文件。

上述代码 生成文档的方法

java文件->Export->Javadoc

在形成doc文件中点击index文件

这样便形成了该类文档

---

嵌入式HTML

javadoc通过生成HTML文档传输HTML文档命令，主要目的是对代码进行格式化。

//: object/Document2.java
/**
*  <pre>
*  System.out.println(new Date());
*  </pre>
*/
///:~

也可以像其他Web文档那样运用HTML，对普通文本进行格式化

//: object/Document3.java
/**
*  You can <em>even</em> insert a list:
*  <ol> Item one
*  <li> Item two
*  </ol>
*/
///:~

标签示例

还有一些标签示例