javadoc 命令的简单使用方法

怕问路 要迷路
--------------------------------------------------
javadoc

这是一个非常有用的命令，用来生成HTML格式的程序文档。

假设我的.java 源文件格式树型目录如下

d:
|-src
|- com
|- javatogo
| |- example1
| |- example2
| |- ...
|---javier
|--- ...

如此复杂的路径，如何编译才能让src目录中中com.*.*包中的所有文件生成文档呢？
如果用参数的话，要写的累死你 javadoc -d . src/com/javatogo/example1 src/com/javatogo/example1...
如果example包下面还有子包的话。。。
而且不同的操作系统，对于命令行的字符数量是有限制的，一旦包的路径多的超过字符限制就更麻烦了。

其实很简单，并不需要使用烦琐的包名参数

使用下面的命令：

javadoc -d e:/docs @option

解释下上面命令的参数 -d 是用来生成目录，如果不使用则在当前路径下生成(关于绝对路径相对路径的问题，这里就不再解释了)

e:/docs 就是生成的文档的目标目录，必须存在，事先建立。

@option 其中@表示后面的是一个参数文件,option 则是一个文本文件的名字，别误解成option.txt 文件名就是option可以是任何名字(为嘛要去加.txt呢...)

option里面究竟有什么内容呢？
使用UltraEdit32打开，文本内容如下：
-d e:/docs
-subpackages com
-splitindex
-doctitle 'CoreJava-- _by Javier Chen'
-header 'javier/'s Files'
-windowtitle 'www.javatogo.com'
-bottom 'Copyright Javier Chen'
-sourcepath d:/src

加这么多的字符写在一个文件中，就可以避免命令行的字符数量限制了。

关键行：
-subpackages com 递归com目录下的所有子目录，这个参数要配合 -sourcepath 来使用

-sourcepath d:/src 包所在的路径。com不是路径，而是根包 也就是说自动搜索src 目录下com包开始的所有子包, 其中源文件文件中 package 语句必须对应分别的包名，不然编译会场生错误。


-doctitle 'CoreJava-- _by Javier Chen'
-header 'javier/'s Files'
-windowtitle 'www.javatogo.com'
-bottom 'Copyright Javier Chen'

这些都是标题参数，以'开始 '结束 可以使用部分网页格式，其中 javier/'s 中的/是转义符，转义后面的'符号而不是代表结束的'符号

--splitindex 是将索引文件按照字母分开存放，不加此参数都存放在一次的，文档小的话，没什么问题，一旦文档的数量庞大了，分开存放可以加快索引文档所花费的时间。

除了纯命令以外
当然，也可以使用JBuiler的javadoc向导等等

javadoc中还有很多其他参数，可以参考使用: