提问：关于javadoc

javadoc -d mydoc aa\*.java   (aa下的所有java文件)

解决方案 »

  1.   

    使い方: javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]
    -overview <file>          HTML ファイルから概要ドキュメントを読み込む
    -public                   public クラスとメンバのみを示す
    -protected                protected/public クラスとメンバを示す (デフォルト)
    -package                  package/protected/public クラスとメンバを示す
    -private                  すべてのクラスとメンバを示す
    -help                     コマンド行オプションを表示して終了する
    -doclet <class>           代替 doclet を介して出力を生成する
    -docletpath <path>        doclet クラスファイルを探す場所を指定する
    -sourcepath <pathlist>    ソースファイルのある場所を指定する
    -classpath <pathlist>     ユーザクラスファイルのある場所を指定する
    -exclude <pkglist>        除外するパッケージリストを指定する
    -subpackages <subpkglist> 再帰的にロードするサブパッケージを指定する
    -breakiterator            BreakIterator で最初の文を計算する
    -bootclasspath <pathlist> ブートストラップクラスローダによりロードされた
                              クラスファイルの位置をオーバーライドする
    -source <release>         指定されたリリースとソースの互換性が提供される
    -extdirs <dirlist>        拡張機能がインストールされた位置をオーバーライドする
    -verbose                  Javadoc の動作についてメッセージを出力する
    -locale <name>            en_US や en_US_WIN などの使用するロケール
    -encoding <name>          ソースファイルのエンコーディング名
    -J<flag>                  <flag> を実行システムに直接渡す標準の doclet により提供されるもの:
    -d <directory>                    出力ファイルの転送先ディレクトリ
    -use                              クラスとパッケージの使用ページを作成する
    -version                          @version パラグラフを含める
    -author                           @author パラグラフを含める
    -docfilessubdirs                  doc-file サブディレクトリを再帰的にコピーする
    -splitindex                       1 字ごとに 1 ファイルに索引を分割する
    -windowtitle <text>               ドキュメント用のブラウザウィンドウタイトル
    -doctitle <html-code>             概要ページにタイトルを含める
    -header <html-code>               各ページにヘッダを含める
    -footer <html-code>               各ページにフッタを含める
    -bottom <html-code>               各ページに下部テキストを含める
    -link <url>                       <url> に javadoc 出力へのリンクを作成する
    -linkoffline <url> <url2>         <url2> にあるパッケージリストを使用して <url> の docs にリンクする-excludedocfilessubdir <name1>:.. 指定された名前の doc-files サブディレクトリをすべて除外する。
    -group <name> <p1>:<p2>..         概要ページにおいて指定するパッケージをグループ化する
    -nocomment                        記述およびタグを抑制し、説明だけを生成する。
    -nodeprecated                     @deprecated 情報を除外する
    -noqualifier <name1>:<name2>:...  出力から修飾子のリストを除外する。
    -nosince                          @since 情報を除外する
    -nodeprecatedlist                 非推奨 API のリストを生成しない
    -notree                           クラス階層を生成しない
    -noindex                          索引を生成しない
    -nohelp                           ヘルプリンクを生成しない
    -nonavbar                         ナビゲーションバーを生成しない
    -quiet                            画面にステータスメッセージを表示しない
    -serialwarn                       @serial タグに関する警告を生成する
    -tag <name>:<locations>:<header>  単一の引数を持つカスタムタグを指定する
    -taglet                           タグレットの完全修飾名を登録する
    -tagletpath                       タグレットのパス
    -charset <charset>                生成されるドキュメントの文字エンコーディング
    -helpfile <file>                  ヘルプリンクのリンク先ファイルを含める
    -linksource                       HTML 形式でソースを生成する
    -stylesheetfile <path>            生成されたドキュメントのスタイル変更用ファイル
    -docencoding <name>               出力エンコーディング名
    不好意思，不存在-h，但是仍然可以显示
    我的系统是日文的，我也看不懂，我想你的应该是英文的帮助
      

  2.   

    Javadoc 选项
    -overview  i>path\filename 
    指定 javadoc 应该从 path\filename 所指定的“源”文件中获取概述文档，并将它放到概述页中（overview-summary.html）。其中 path\filename 是相对于 -sourcepath 的相对路径名。
    尽管可对 filename 使用任何名字并将它放在 path 指定的任何地方，但是通常将它命令为 overview.html 并将它放入包含最顶级包目录的源目录树中。在该位置，建立包文档时不需要 path，因为 -sourcepath 将指向该文件。例如，如果 java.lang 包的源目录树是 /src/classes/java/lang/，则可以概述文件放到 /src/classes/overview.html。参见 实际示例。
    -public 
    只显示公有类及成员。-protected 
    只显示受保护的和公有的类及成员。这是缺省状态。-package 
    只显示包、受保护的和公有的类及成员。-private 
    显示所有类和成员。-help 
    显示联机帮助，它将列出这些 javadoc 和 doclet 命令行选项。-doclet class 
    指定启动用于生成文档的 doclet 的类文件。该 doclet 定义了输出的内容和格式。如果未使用 -doclet 选项，则 javadoc 使用标准 doclet 生成缺省 HTML 格式。该类必须包含 start(Root) 方法。该启动类的路径由 -docletpath 选项定义。-docletpath classpathlist 
    指定 doclet 类文件的路径，该类文件用 -doclet 选项指定。如果 doclet 已位于搜索路径中，则没有必要使用该选项。-1.1 
    生成具有用 Javadoc 1.1 生成的文档的外观和功能的文档。也就是说，页的背景为灰色，用图像做页眉，使用 bullet 列表而不是表格，具有单级目的目录结构，不包含继承 API，不使用 HTML 框架，并且不支持内部类。该选项还将索引分割成每个字母一个文件。如果想要这种外观，则该选项比 javadoc 1.1 优越之处在于修正了一些错误。
    不是所有选项都能用于 -1.1 选项。为了查看哪些选项可用，可执行：  C:> javadoc -1.1 -help在该列表中显示的 -footer 选项在功能上与本页中其他地方介绍的 -bottom 选项相同。而 -title 选项在功能上与 -doctitle 相同。
    -sourcepath sourcepathlist 
    当将包名传递到 javadoc 命令中时，指定查找源文件（.java）的搜索路径。注意只有当用 javadoc 命令指定包名时才能使用 sourcepath 选项 -- 它将不会定位传递到 javadoc 命令中的 .java 文件。如果省略 -sourcepath，则 javadoc 使用类路径查找源文件（参见 -classpath）。
    将 sourcepathlist 设置成正在生成其文档的包的源树的根目录。例如，假定想要为叫作 com.mypackage 的包建立文档，其源文件位于：C:\user\src\com\mypackage\*.java在这种情况下，将把 sourcepath 指定为 C:\user\src，该目录包含 com\mypackage，然后提供包名 com.mypackage：javadoc -sourcepath C:\user\src com.mypackage这是相当容易记忆的，注意如果将源路径和包名级联到一起，并将点号改为斜杠“/”，则最后将得到该包的完整路径：C:\user\src\com\mypackage. 
    -classpath classpathlist 
    指定 javadoc 将在其中查找 引用类 的路径 -- 引用类是指带文档的类加上它们引用的任何类。Javadoc 将搜索指定路径的所有子目录。classpathlist 可以包含多个路径，它们用分号分隔。有关如何指定 classpathlist，请遵循 类路径 文档中的指令。
    如果省略 -sourcepath，则 Javadoc 使用 -classpath 查找源文件和类文件（为了向后兼容性）。因而，如果想要在不同的路径中搜索源文件和类文件，则应使用 -sourcepath 和 -classpath 两个选项。例如，如果想要建立 com.mypackage 的文档，其类位于目录 C:\user\src\com\mypackage 中，并且该包依赖于 C:\user\lib 中的库，则将会指定：   C:> javadoc -classpath \user\lib -sourcepath \user\src com.mypackage与其他工具一样，如果不指定 -classpath，则 Javadoc 将使用 CLASSPATH 环境变量（如果它已设置）。如果二者都未设置，则 Javadoc 将从当前目录中搜索类。有关 Javadoc 如何使用 -classpath 查找用户类及相关扩展类和自举类的深入介绍，参见 如何查找类。
    -bootclasspath classpathlist 
    指定自举类所在路径。它们名义上是 Java 平台类。这个 bootclasspath 是 Javadoc 将用来查找源文件和类文件的搜索路径的一部分。有关详细信息，参见 如何查找类。在 classpathlist 中用分号（;）分隔目录。-extdirs dirlist 
    指定扩展类所在的目录。它们是任何使用 Java 扩展机制的类。这个 extdirs 是 Javadoc 将用来查找源文件和在文件的搜索路径的一部分。有关详细信息，参见上面的 -classpath。在 dirlist 中用分号（;）分隔目录。-verbose 
    在 javadoc 运行时提供更详细的信息。不使用 verbose 选项时，将显示加载源文件、生成文档（每个源文件一条信息）和排序的信息。verbose 选项导致打印额外的信息，指定解析每个 java 源文件的毫秒数。-locale language_country_variant 
    指定 javadoc 在生成文档时使用的环境。该参数为环境名，如 java.util.Locale 文档中所述，例如 en_US（英语，美国）或 en_US_WIN（Windows 变量）。
    指定环境将导致 javadoc 为各种信息（导航栏中的字符串、列表和表格的标题、帮助文件内容、stylesheet.css 中的注释，等等）选择使用该环境的资源文件。它还指定按字母次序排序列表的排序次序，以及用于确定第一句结束的语句分隔符。它不决定带文档类的源文件中指定的文档注释文本的环境。
    -encoding name 
    指定源文件编码名，例如 EUCJIS/SJIS。如果未指定该选项，则使用平台缺省转换器。-Jflag 
    将 flag 直接传递给运行 javadoc 的运行时系统 java。注意在 J 和 flag 之间不能有空格。
      

  3.   

    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
    -doclet <class>           Generate output via alternate doclet
    -docletpath <path>        Specify where to find doclet class files
    -1.1                      Generate output using JDK 1.1 emulating doclet
    -sourcepath <pathlist>    Specify where to find source files
    -classpath <pathlist>     Specify where to find user class files
    -bootclasspath <pathlist> Override location of class files loaded
      by the bootstrap class loader
    -extdirs <dirlist>        Override location of installed extensions
    -verbose                  Output messages about what Javadoc is doing
    -locale <name>            Locale to be used, e.g. en_US or en_US_WIN
    -encoding <name>          Source file encoding name
    -J<flag>                  Pass <flag> directly to the runtime systemProvided by Standard doclet:
    -d <directory>            Destination directory for output files
    -use                      Create class and package usage pages
    -version                  Include @version paragraphs
    -author                   Include @author paragraphs
    -splitindex               Split index into one file per letter
    -windowtitle <text>       Browser window title for the documenation
    -doctitle <html-code>     Include title for the package index(first) page
    -header <html-code>       Include header text for each page
    -footer <html-code>       Include footer text for each page
    -bottom <html-code>       Include bottom text for each page
    -link <url>               Create links to javadoc output at <url>
    -linkoffline <url> <url2> Link to docs at <url> using package list at <url2>
    -group <name> <p1>:<p2>.. Group specified packages together in overview page
    -nodeprecated             Do not include @deprecated information
    -nosince                  Do not include @since information
    -nodeprecatedlist         Do not generate deprecated list
    -notree                   Do not generate class hierarchy
    -noindex                  Do not generate index
    -nohelp                   Do not generate help link
    -nonavbar                 Do not generate navigation bar
    -serialwarn               Generate warning about @serial tag
    -charset <charset>        Charset for cross-platform viewing of generated documentation.
    -helpfile <file>          Include file that help link links to
    -stylesheetfile <path>    File to change style of the generated documentation
    -docencoding <name>       Output encoding name
      

  4.   

    用个IDE吧,比如Eclipse什么的,有生成javadoc的功能,点一下就出来了