JavaDoc使用

Java中提供了JavaDoc命令用于根据注释自动生成JavaDoc文档

 

1)以/**开始，以*/结束，里面可以包含普通文本、HTML标记、javadoc标记

 

2)JavaDoc只处理Java源文件中在类声明、接口声明、成员方法声明、成员变量声明及构造函数之前的注释

 

JavaDoc标记：

@version  指定版本信息

@since     指定最早出现在那个版本中

@author   指定作者

@see        生成参考其JavaDoc文档的链接

@link         生成参考其JavaDoc文档的链接，区别在于，它能够嵌入到注释语句中，为特定的词汇生成链接

@deprecated   标识被注释的类、变量、方法不被提倡

@param    描述方法的参数

@return    描述方法的返回值

@throws   描述方法抛出的异常

 

位于package关键字前边的注释将会被忽视

 

例：

 /**

    * 获得有默认情况下所说的话

    *

    * return   返回默认情况下的信息

    *

    * @see #setWord()

    *

    * @deprecated  该方法已被废弃

    *

    */

 

其中@see 标记用于生成参考其它JavaDoc文档的链接

 

1）链接到其它类的JavaDoc文档，必须给出完整的类名

     @see com.sun.java.ShowDate

 

2）链接当前类的方法或变量的JavaDoc文档

     @see #setDate()

     @see #date

 

3）链接到其它类的方法或变量

     @see com.sun.java.ShowDate()#setDate()

     @see com.sun.java.ShowDate()#date

 

/**

   * <ul>

   * <li>如果{@link#date成员变量}不为null

   * </ul>

   *@param

   *@return 无返回值

   *@exception Exception

   *

   */

 

javadoc命令的用法：

-public        仅public标识的类或成员生成javadoc文档

-protected  仅public，protected标识的类或成员生成javadoc文档

-package    仅public、protected、默认访问级别的类或成员生成javadoc文档

-private      public、protected、默认、private标识的类或成员生成javadoc文档

-version      解析@version标记

-author       解析@author标记

-splitindex   将索引分为每个字母对应一个索引

-sourcepath Java源文件的路径

-classpath    指定classpath

-d                 JavaDoc文档的输出目录

 

语法：javadoc [option] [packageNames] [sourcefiles]

         它既可以处理包，也可以处理Java源文件

 

1)Javadoc处理包

javadoc -author -version -sourcepath src -d doc/API com.sun.java.lang

 

生成的JavaDoc包括3部分：包列表、类列表、类说明

 

javadoc会依次处理每个包中的所有Java类。但指定包的子包是不会被自动处理的。执行完它地在指定的目录下生成HTML文件，它的首页为index.html

 

2)Javadoc处理多个类：如果指定类的包中还有其它类，将不会自动进行处理

javadoc -author -version -sourcepath src -d doc/API com/sun/java/util/ArrayList.java com/sun/java/lang/System.java

 

-splitindex  当文档不多的时候，不一定要使用此选项。如果使用此选项将每个字母对应一个索引文件

例如：doc/API目录下有一个index_all.html文件，使用比较的，每个字母对应一个索引文件，这些索引文件放在doc/api/inex_files目录下