疯狂java


您现在的位置: 疯狂软件 >> 新闻资讯 >> 正文

Java文档注释(9)—[疯狂java讲义]


 

        接下来还是使用上面编写的三个Java文件,但把这三个Java文件按包结构分开组织存放,并提供对应的包描述文件,源文件和对应包描述文件的组织结构如下所示(该示例位于光盘的codes33.1package路径下):
        1、lee文件夹:包含TestJavadoc.java文件(该Java类的包为lee),对应包描述文件package.html。
        2、package文件夹:包含Test.java文件和TestJavadocTag.java文件(这两个Java类的包为yeeku),对应包描述文件package.html。
        在命令行窗口进入lee和yeeku所在路径,执行如下命令:
Javadoc –d apidoc –windowtitle 测试 –dcotitle 学习 javadoc 工具的测试API文档 –header 自定义类 –version –author lee yeeku
        上面命令指定对lee包和yeeku包来生成API文档,而不是对Java源文件来生成API文档,这也是允许的。其中lee包和yeeku包下面都提供了对应的包描述文件。
打开上面命令生成的API文档的首页,将可以看到如图3.7所示的首页:
 
        可能有读者会发现,如果需要设置包描述信息,则应该将Java源文件按包结构来组织存放,这不是问题。实际上,当编写Java源文件时,按包结构来组织存放Java源文件是一个不错的选择,更有利于项目的管理。
        现在生成的API文档己经非常“专业”了,和系统提供的API文档基本类似,关于Java文档注释和javadoc工具使用的介绍也基本告一段落了。(未完.摘自[疯狂java讲义].李刚)