疯狂java


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

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


 

javadoc命令的基本用法如下:
       javadoc选项Java源文件/包。
       javadoc命令可对源文件、包来生成API文档,在上面的语法格式中(详见《Java文档注释(5)—[疯狂java讲义]》),Java源文件可以支持通配符,例如使用*.Java来代表当前路径下所有Java源文件。javadoc的常用选项有如下几个:
       1、-d <directory>:该选项指定一个路径,用于将生成的API文档放到指定目录下。
       2、-windowtitle <text>:该选项指定一个字符串,用于设置API文档的浏览器窗口标题。
       3、doctitle <html-code>:该选项指定一个日下HTML格式的文本,用于指定概述页面的标题。
注意:一定要对处于多个包下的源文件来生成API文档时,才有概述页面。
       4、-header <html-code>:该选项指定一个日下HTML格式的文本,包含每个页面的页眉。
       除此之外,javadoc命令还包含了大量其他选项,读者可以通过在命令行窗口执行javadoc-help来查看javadoc命令的所有选项。
命令行窗口执行如下命令来为刚刚编写的两个Java程序生成API文档:
Javadoc –d apidoc –windowtitle 测试 –doctitle 学习 javadoc 工具的测试API文档 –header 自定义类 Test*.java(未完.摘自[疯狂java讲义].李刚)