javadoc（详细用法见JDK或者百度具体的参数表示的意义）

一、目的

为了使代码与文档更好的结合，更好地管理代码

二、语法

所有 javadoc命令都只能始于“/**”注释，和一般注释一样，结束于 “*/”。  使用 javadoc
的方式主要有两种：嵌入 HTML，或使用“文档标签（doc tag）”。所谓“文档标签”是一
些以“@”字符开头的命令，且该“@”字符要置于注释行的最前面（即忽略前导 “*”之后
的最前面）。而“行内文档标签（inline doc tag）”则可以出现在 javadoc 注释中的任何地方，
它们也是以“@”字符开头，但要括在花括号内。

 

共有三种类型的注释文档，分别对应于注释位置后面的三种元素：类、变量和方法。也就是
说，类注释正好位于类定义之前；变量注释正好位于变量定义之前；而方法定义也正好位于
方法定义的前面。如下面这个简单的例子所示：
 
/** A class comment */
public class DocTest {
  /** A variable comment */
  public int i;
  /** A method comment */
  public void f() {}
}
 
注意，javadoc 只能为“public（公共）”和“protected（受保护）”成员进行文档注释。 “private
（私有）”和包内可访问成员的注释会被忽略掉，所以输出结果中看不到它
们（不过可以用-private进行标记，以便对 private 成员一并处理）。这样做是有道理的，因
为只有 public 和 protected 成员才能在文件之外被使用，这是客户端程序员所期望的。至于
所有对类所作的注释，则都会包含在输出结果中。

在myeclipse里还可以设置相应的格式方便代码的管理。

 

嵌入式 HTML

 

javadoc 将 HTML 命令嵌入到它所生成的 HTML文档中。这使你能够充分利用 HTML 的功
能。当然，其主要目的还是为了对代码进行格式化。下面列出一个例子：
 
   /**
* <pre>
* System.out.println(new Date());
* </pre>
*/
 
 
你也可以像在其他 Web文档中那样运用 HTML，对普通文本按照你自己所描述的进行格式化。

/**
* You can <em>even</em> insert a list:
* <ol>
* <li> Item one
* <li> Item two
* <li> Item three
* </ol>
*/
 
注意，在文档注释中，位于每一行最开头的星号和前导空格都会被 javadoc 丢弃。Javadoc
会对所有内容重新格式化，使其与标准的文档外观一致。不要在嵌入式 HTML 中使用标题
标签，例如：<h1>或<hr>，因为 javadoc 会插入自己的标题，而你的标题可能会对它造成干
扰。
 
所有类型的注释文档——类、变量和方法——都支持嵌入式 HTML。