javadoc 生成帮助文档

[2004-5-14 19:05]
开始写文档了javadoc 文档生成还是比较简单的但是每个细节都考虑到就不是很容易的事情了

[2004-5-14-19:32]
抗不住了只好看英文的javadoc帮助了:)

javadoc工具处理以 .java结尾的文件以及SourceFiles中的文件
这样说来 javadoc specialfilename.java 是合法的但是意义不大
更多的方式是

(1)传包名 javadoc edu.jlu.lilac (edu是当前目录
的目录)这样产生的文档只包括edu.jlu.lilac中的java文件如果有
目录 edu.jlu.lilac.dd则dd下面的java文件不会被生成文档。
同理不要试图运行类似javadoc src.edu.jlu.lilac这样的命令
因为lilac下面的.java文件都写着package edu.jlu.lilac;
javadoc还是聪明的
对了一定要制定一个目录放置文档要不他会在.java文件的同级目录下
生成一堆.html 文件:(

(2)使用-subpackages 参数
(这个命令蛮怪的第一次运行什么也没有后来发现是错误太多了-_-!)

这个命令可以自动帮你递归指定包下的子包 生成一整套的文档
c:\javadoc -d docs -sourcepath c:\javadoc\ -subpackages edu.jlu.lilac.dd
tree javadoc得到

├─edu
│  └─jlu
│      └─lilac
│          └─dd
│              ├-mm
│              ├─gg
│              ├─jj
│              ├─xx
│              └─otherpackage
│                  ├─in
│                  └─out

然后你在c:\docs下面就能看到生成的完整文档了：）当然不只是edu.jlu.lilac.dd包下面的
还有列出的其他的子包

到这个地方我的任务已经解决了(javadoc 还是蛮强大的这些只是皮毛)
如果大家有兴趣可以参考自己jsdk问当中的javadoc tool help那一页
(我在网上找了半天最后还是发现这个一看就搞定了 郁闷)

上面的命令如果配合-exclude参数的话
c:\javadoc -d docs -sourcepath c:\javadoc\ -subpackages edu.jlu.lilac.dd
-exclude edu.jlu.lilac.dd.mm:edu.jlu.lilac.dd.gg
以上是一行
就是生成edu.jlu.lilac.dd下面除mm,gg的所有子包文档

(3)使用通配符   *.java