JAVADOC 常见使用方法

C:\java>javadoc  JavadocDemo.java如果没有指定文件生成目录，则文件生成目录为：C:\Documents and Settings\Administrator

我们知道Java中有三种注释语句：

1.//用于单行注释。
2./*...*/用于多行注释，从/*开始，到*/结束，不能嵌套。
3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。
   javadoc工具能从java源文件中读取第三种注释，并能识别注释中用@标识的一些特殊变量（见表），制作成Html格式的类说明文档。 javadoc不但能对一个java源文件生成注释文档，而且能对目录和包生成交叉链接的html格式的类说明文档，十分方便。

注释中可以出现的关键字，以@开头： @author        作者名 @version       版本标识 @parameter     参数名及其意义 @since         最早出现的JDK版本 @return        返回值 @throws        异常类及抛出条件 @deprecated    引起不推荐使用的警告 @see           交叉参考 下面是javadoc.exe的用法 C:\java>javadoc -help C:\java>javadoc -help

usage: javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]
-overview <file>          Read overview documentation from HTML file
-public                   Show only public classes and members
-protected                Show protected/public classes and members (default)
-package                  Show package/protected/public classes and members
-private                  Show all classes and members
-help                     Display command line options and exit
-doclet <class>           Generate output via alternate doclet
-docletpath <path>        Specify where to find doclet class files
-sourcepath <pathlist>    Specify where to find source files
-classpath <pathlist>     Specify where to find user class files
-exclude <pkglist>        Specify a list of packages to exclude
-subpackages <subpkglist> Specify subpackages to recursively load
-breakiterator            Compute 1st sentence with BreakIterator
-bootclasspath <pathlist> Override location of class files loaded by the bootstrap class loader
-source <release>         Provide source 

转载于:https://www.cnblogs.com/snowberg/archive/2011/09/09/2468603.html