javadoc注释文档

按照一定格式为Java类和方法添加注释，可以通过javadoc生成类和方法的说明文档：

1. 语法

javadoc命令只能出现在""注释中，主要有两种方式：嵌入式HTML，或者“文档标记”。注意javadoc只能为声明为public，protected的成员变量和方法生成文档，private和friendly成员变量和方法的注释会被忽略。但是，所有类的注释都会包含在文档中。

public class DocExample{

   

    public inti;

   

    public voidmyMethod() {}

}

2. 嵌入式HTML

javadoc将HTML命令传递给最终生成的HTML文档

或者

3. @see 引用其他类

@see 类名

@see 完整类名

@see 完整类名#方法名

4. 类文档标记

@version 版本信息

@author 作者信息

5. 变量文档标记

只能包含嵌入的HTML和@see引用

6. 方法文档标记

@param 参数名  说明

@return 说明

@exception 完整类名 说明

@deprecated //指出该方法以过时

7. 例子

//: Property.java

import java.util.*;

 

public class Property {

 

  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());

  }

}