您的位置:首页技术文章
文章详情页

Javadoc的简捷使用

【字号: 日期:2024-06-15 14:03:11浏览:2作者:猪猪
内容: 大家都知道,J2SE5中的javadoc.exe的命令行可选参数多达五十余个,其复杂性可想而知,是不是看着头都大了呢?但通常情况下,我们不想那么麻烦!假设源代码在 C:src 目录下,其中 com.liigo 是主包,其下可能有数十个子包,数百(千)个Java文件。目录结构大约是这样的:- C: | src | com | liigo | ***怎么才能以最简捷的方式生成所有的API文档呢?c:>c:>cd srcc: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 以递归的方式处理各子包。关键参数!如果不使用本参数,每次只能处理一个子包(或需手工列出所有子包)。 注:以上示例要求 javadoc.exe 所在路径位于系统环境变量“PATH中。补充一点:使用参数 -author 可以将作者信息(@author ***)导出到最终生成的API文档中, -version 可以生成版本信息。如果是自己写的一个包,千万不要忘了用 -author 哦:)最终完整的命令行是:...>javadoc -d c:doc -sourcepath c:src -subpackages com.liigo -author -version Java, java, J2SE, j2se, J2EE, j2ee, J2ME, j2me, ejb, ejb3, JBOSS, jboss, spring, hibernate, jdo, struts, webwork, ajax, AJAX, mysql, MySQL, Oracle, Weblogic, Websphere, scjp, scjd 大家都知道,J2SE5中的javadoc.exe的命令行可选参数多达五十余个,其复杂性可想而知,是不是看着头都大了
标签: Java
相关文章: