javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形成程序的开发文档了。
javadoc命令是用来生成自己API文档的,使用方式:使用命令行在目标文件所在目录输入javadoc +文件名.java。
常用标记
此外还有@serial、@serialField、@serialData、{@docRoot}、{@inheritDoc}、{@literal}、{@code} {@value arg}几个不常用的标签,由于不常使用,我们不展开叙述,感兴趣的读者可以查看帮助文档。
命令格式
Javadoc命令格式如下:
javadoc [选项] [软件包名称] [源文件]
其中选项有:
-overview \u003c文件\u003e 读取 HTML 文件的概述文档
-public 仅显示公共类和成员
-protected 显示受保护/公共类和成员(默认)
-package 显示软件包/受保护/公共类和成员
-private 显示所有类和成员
-help 显示命令行选项并退出
-doclet \u003c类\u003e 通过替代 doclet 生成输出
-docletpath \u003c路径\u003e 指定查找 doclet 类文件的位置
-sourcepath \u003c路径列表\u003e 指定查找源文件的位置
-classpath \u003c路径列表\u003e 指定查找用户类文件的位置
-exclude \u003c软件包列表\u003e 指定要排除的软件包的列表
-subpackages \u003c子软件包列表\u003e 指定要递归装入的子软件包
-breakiterator 使用 BreakIterator 计算第 1 句
-bootclasspath \u003c路径列表\u003e 覆盖引导类加载器所装入的类文件的位置
-source \u003c版本\u003e 提供与指定版本的源兼容性
-extdirs \u003c目录列表\u003e 覆盖安装的扩展目录的位置
-verbose 输出有关 Javadoc 正在执行的操作的消息
-locale \u003c名称\u003e 要使用的语言环境,例如 en_US 或 en_US_WIN
-encoding \u003c名称\u003e 源文件编码名称
-quiet 不显示状态消息
-J\u003c标志\u003e 直接将 \u003c标志\u003e 传递给运行时系统
参考资料
Warning: Invalid argument supplied for foreach() in
/www/wwwroot/newbaike1.com/id.php on line
362