`

javadoc命令

    博客分类:
  • Java
 
阅读更多
以下内容引用自(原文更全):http://hi.baidu.com/%B1%CA%C3%FB%D3%F1%CA%F7%B7%E7/blog/item/412048dab8e4102c32fa1c44.html
引用

假设源代码在 C:src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:

- C:
    | src
      | com
        | liigo

           | ***

怎么才能以最简捷的方式生成所有的API文档呢?

c:>
c:>cd src
c:src>javadoc -d doc -subpackages com.liigo

这样就搞定了,最终生成的API文档位于 c:srcdoc 目录(该目录是由javadoc.exe自动生成的)。

上面的用法利用了“当前目录”和“相对路径”,当然也可以用绝对路径:

...>javadoc -d c:doc -sourcepath c:src -subpackages com.liigo

最终生成的API文档位于 c:doc 目录(该目录同样是由javadoc.exe自动生成的)。


总结一下:

我们只用到了javadoc的三个参数: -d,-subpackages,-sourcepath,其中:

参数 说明
-d 指定API文档的输出目录,默认是当前目录。建议总是指定该参数。
-sourcepath 指定源代码路径,默认是当前目录。 此参数通常是必须的。
-subpackages 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。
分享到:
评论

相关推荐

Global site tag (gtag.js) - Google Analytics