Java中文档生成JavaDoc使用注意

标签：android   javadoc   

所有 javadoc 命令都只能出现于“/**”注释中

主要通过两种方式来使用 javadoc：嵌入的 HTML，或使用“文档标记”。

其中，“文档标记”（Doc tags）是一些以“@”开头的命令，置于注释行的起始处（但前导的“*”会被忽略）。

有三种类型的注释文档，它们对应于位于注释后面的元素：类、变量或者方法。也就是说， 一个类注释正好
位于一个类定义之前；变量注释正好位于变量定义之前；而一个方法定义正好位于一个方法定义的前面。如
下面这个简单的例子所示：
/** 一个类注释 */
public class docTest {
/** 一个变量注释 */
public int i;
/** 一个方法注释 */
public void f() {}
}


注意 javadoc 只能为 public（公共）和 protected （受保护）成员处理注释文档。“private”（私有）和“友好”成员的注释会被忽略，我们看不到任何输出（也可以用-private 标记包括 private 成员）。因为只有 public 和 protected 成员才可在文件之外使用。

嵌入 H T M L

/**
* <pre>
* System.out.println(new Date());
* </pre>
*/

/**
* 您<em> 甚至</em>可以插入一个列表：
* <ol>
* <li> 项目一
* <li> 项目二
* <li> 项目三
* </ol>
*/

同时丢弃的还有前导空格。 

javadoc 会对所有内容进行格式化，使其与标准的文档外观相符。

不要将<h1> 或<hr> 这样的标题当作嵌入 HTML 使用，因为javadoc 会插入自己的标题，我们给出的标题会与之冲撞。
所有类型的注释文档——类、变量和方法——都支持嵌入 HTML。

@ s e e ：引用其他类

所有三种类型的注释文档都可包含@see 标记，它允许我们引用其他类里的文档。对于这个标记， javadoc 会
生成相应的 HTML，将其直接链接到其他文档。格式如下：
@see 类名
@see 完整类名
@see 完整类名#方法名

每一格式都会在生成的文档里自动加入一个超链接的“See Also ”（参见）条目。注意 javadoc 不会检查我们指定的超链接，不会验证它们是否有效。

//: Property.java
import java.util.*;
/** The first Thinking in Java example program.
 * Lists system information on current machine.
 * @author Bruce Eckel
 * @author http://www.BruceEckel.com
 * @version 1.0
*/
public class Property {
 /** Sole entry point to class & application
 * @param args array of string arguments
 * @return No return value
 * @exception exceptions No exceptions thrown
 */
 public static void main(String[] args) {
 System.out.println(new Date());
 Properties p = System.getProperties();
 p.list(System.out);
 System.out.println("--- Memory Usage:");
 Runtime rt = Runtime.getRuntime();
 System.out.println("Total Memory = "
 + rt.totalMemory()
 + " Free Memory = "
 + rt.freeMemory());
 }
} ///:~

Java中文档生成JavaDoc使用注意

标签：android   javadoc   

原文地址：http://blog.csdn.net/adayabetter/article/details/44938491