免费注册 查看新帖 |

Chinaunix

  平台 论坛 博客 文库
最近访问板块 发新帖
查看: 931 | 回复: 0
打印 上一主题 下一主题

JDK开发工具包详解(一) [复制链接]

论坛徽章:
0
跳转到指定楼层
1 [收藏(0)] [报告]
发表于 2007-05-19 07:52 |只看该作者 |倒序浏览

JDK开发工具包详解
-------------------------------------------------------------------------------------------------------------------------------------------
  Java 开发工具包是Sun公司的Java Software产品。他可以非常方便的开发和调试JAVA应用程序。下面就详细介绍这些工具的使用:
====================

javadoc.exe
  
功能说明:Java API文档生成器从Java源文件生成API文档HTML页。

语法:javadoc [ 命令选项 ] [ 包名 ] [ 源文件名 ] [ @files ]
其中[ 包名 ]为用空格分隔的一系列包的名字,包名不允许使用通配符,如(*)。[ 源文件名 ]为用空格分隔的一系列的源文件名,源文件名可包括路径和通配符,如(*)。[ @files ]是以任何次序包含包名和源文件的一个或多个文件。

补充说明:
Javadoc解析Java源文件中的声明和文档注释,并产生相应的HTML页缺省),描述公有类、保护类、内部类、接口、构造函数、方法和域。
在实现时,Javadoc要求且依赖于java编译器完成其工作。Javadoc调用部分javac编译声明部分,忽略成员实现。它建立类的内容丰富的内部表示,包括类层次和“使用”关系,然后从中生成HTML。Javadoc还从源代码的文档注释中获得用户提供的文档。
当Javadoc建立其内部文档结构时,它将加载所有引用的类。由于这一点,Javadoc必须能查找到所有引用的类,包括引导类、扩展类和用户类。
命令选项:
-overview                  指定javadoc应该从path/filename所指定的“源”文件中获取概述文档,并将它放到概述页中
(overview-summary.html)。其中path/filename 是相对于-sourcepath的相对路径名。
  -public                         只显示公有类及成员。
  -protected                     只显示受保护的和公有的类及成员。这是缺省状态。
  -package                      只显示包、受保护的和公有的类及成员。
  -private                        显示所有类和成员。
  -help                           显示联机帮助,它将列出这些javadoc和doclet命令行选项。
-doclet class                        指定启动用于生成文档的docle 的类文件。该doclet定义了输出的内容和格式。如果未使用-doclet选项,则javadoc使用标准doclet生成缺省HTML格式。该类必须包含start(Root)法。该启动类的路径由 -docletpath选项定义。
-docletpath           指定doclet类文件的路径,该类文件用-doclet选项指定。如果doclet已位于搜索路径中,则没有
必要使用该选项。
-sourcepath               当将包名传递到javadoc命令中时,指定定位源文件(.java)的搜索路径。注意只有当用 javadoc
命令指定包名时才能使用sourcepath选项 -- 它将不会查找传递到javadoc命令中的.java文件。
如果省略-sourcepath,则javadoc使用类路径查找源文件。 
-classpath             指定javadoc将在其中查找引用类的路径 -- 引用类是指带文档的类加上它们引用的任何类。
Javadoc将搜索指定路径的所有子目录。classpathlist可以包括多个路径,彼此用逗号分隔。
-bootclasspath        指定自举类所在路径。它们名义上是Java平台类。这个bootclasspath是Javadoc将用来查找源文
件和类文件的搜索路径的一部分。在 classpathlist中用冒号(:)分隔目录。
-extdirs dirlist            指定扩展类所在的目录。它们是任何使用Java扩展机制的类。这个 extdirs是Javadoc将用来查
找源文件和在文件的搜索路径的一部分。在dirlist中用冒号(:)分隔目录。
-verbose                       在javadoc运行时提供更详细的信息。不使用verbose选项时,将显示加载源文件、生成文档(每
个源文件一条信息)和排序的信息。verbose选项导致打印额外的信息,指定解析每个java源文
件的毫秒数。
  -locale                     指定javadoc在生成文档时使用的环境。
  -encoding name            指定源文件编码名,例如EUCJIS/SJIS。如果未指定该选项,则使用平台缺省转换器。
  -J[flag]                        将flag直接传递给运行javadoc的运行时系统java。注意在J和flag之间不能有空格。

  标准 Doclet 提供的选项

-d                       directory 指定javadoc保存生成的HTML件的目的目录。省略该选项将导致把文件保存到当前目、
录中。其中directory可以是绝对路径或相对当前工作目录的相对路径。
-use                    对每个带文档类和包包括一个“用法”页。该页描述使用给定类或包的任何 API 的包、类、方法、
构造函数和域。对于给定类 C,使用类 C 的任何东西将包括 C 的子类、声明为 C 的域、返回
C 的方法以及具有 C 类型参数的方法和构造函数。
  -version                  在生成文档中包括 @version 文本。缺省地将省略该文本。
  -author                   在生成文档中包括 @author 文本。
-splitindex               将索引文件按字母分割成多个文件,每个字母一个文件,再加上一个包含所有以非字母字符开头
的索引项的文件。
-windowtitle           指定放入 HTML 标记中的标题。它将出现在窗口标题栏中和为该页创建的任何浏览器书签
(最喜爱的位置)中。该标题不应该包含任何 HTML 标记,因为浏览器将不能正确解释它们。在
title 中的任何内部引号必须转义。如果省略 -windowtitle,则 Javadoc 对该选项使用 -doctitle 的
值。
-doctitle[title]          指定放置在靠近概述概览文件顶部的标题。该标题将作为一级标题,居中地直接放在导航栏下
面。title 可包含 html 标记和空格,但是如果这样,则必须用引号将它括起。在 title 中的任何内
部引号必须转义。
-title[title]                该选项不再存在。它仅存在于 Javadoc 1.2 的 Beta 版中。它已重命名为 -doctitle。重命名该选项
是为了更清楚地表示它定义文档标题而不是窗口标题。
-header              指定放置在每个输出文件顶部的页眉文本。该页眉将放在上部导航栏的右边。header可包含
HTML 标记和空格,但是如果这样则必须用引号将它括起。在 header 中的任何内部引号必须转
义。
-footer              指定放置在每个输出文件底部的脚注文本。脚本将放置在下部导航栏的右边。footer 可包含 html
标记和空格,但是如果这样,则必须用引号将它括起。在 footer 中的任何内部引号必须转义。
-bottom                指定放置在每个输出文件底部的文本。该文本将放置在页底,位于下部导航栏的下面。其中 text 可
包含 HTML 标记和空格,但是如果这样,则必须用引号将它括起。在 text 中的任何内部引号必
须转义。
-link[docURL]         创建链接指向已用 javadoc-生成的外部引用类的文档。参数 docURL是想要链接到的 javadoc-生
成的外部文档的 URL。该位置可以是相对的或绝对的 URL。
  -linkoffline               [docURL][packagelistURL] 该选项为外部引用类名字创建指向文档的链接。
  -group                 将概述页上的包分成指定的组,每组一个表格。用不同的 -group 选项指定每个组。各组按命令行
中指定的次序出现在页面上。组内的包按字母排序。对于给定 -group 选项,与 packagepattern 表
达式列表匹配的包出现在标题为 groupheading 的表格中。
-nodeprecated         防止在文档中生成任何不鼓励使用的 API。它执行-nodeprecatedlist 所做的事情,并且它不在文档
其余部分生成任何不鼓励使用的 API。当编写代码并不想被不鼓励使用的代码分心时,这是非常
有用的。
-nodeprecatedlist      防止在生成文件中包含不鼓励使用的 API 列表(deprecated-list.html)并防止在导航栏中包含该页
的链接。(但是,javadoc 继续在文档其余部分生成不鼓励使用的 API。) 如果源代码未包含不
鼓励使用的 API,并且想要导航栏更干净,则它是非常有用的。
  -notree                   在生成文档中忽略类/接口层次。缺省地,将产生该层次。
  -noindex                 在生成文档中忽略索引。缺省地,将产生索引。
  -nohelp                   在输出的每页顶部和底部的导航栏中忽略“帮助”链接。
  -nonavbar               防止产生导航栏、页眉和脚注,否则它们将出现在生成页的顶部和底部。它对“bottom”选项没
有影响。当只对内容感兴趣并且没有必要导航时,例如仅将文件转换成 PostScript 或 PDF 以进行
打印,-nonavbar 选项是非常有用的。
-helpfile               指定顶部和底部导航栏中“帮助”链接所链接到的替代帮助文件 path/filename 的路径。不使用该选
项时,Javadoc 自动创建帮助文件 help-doc.html,它在 Javadoc 中硬编码。该选项使得可覆盖这种
缺省情况。其中 filename 可以是任何名字,不局限于 help-doc.html -- Javadoc 将相应调整导航栏中
的链接。
-stylesheetfile        指定替代 HTML 样式表单文件的路径。不使用该选项时,Javadoc 将自动创建样式表单文件
stylesheet.css,它在 Javadoc 中硬编码。该选项使得可覆盖这种缺省情况。其中 filename 可以是任
何名字,不局限于 stylesheet.css。
-docencoding     指定输出 HTML 文件的编码方式。

这是排版好后的.doc文档,有兴趣打印的朋友可以下载! 因有字数限制只好连载了!

文件:
Java开发工具包详解.rar
大小:
21KB
下载:
下载


本文来自ChinaUnix博客,如果查看原文请点:http://blog.chinaunix.net/u1/38934/showart_304567.html
您需要登录后才可以回帖 登录 | 注册

本版积分规则 发表回复

  

北京盛拓优讯信息技术有限公司. 版权所有 京ICP备16024965号-6 北京市公安局海淀分局网监中心备案编号:11010802020122 niuxiaotong@pcpop.com 17352615567
未成年举报专区
中国互联网协会会员  联系我们:huangweiwei@itpub.net
感谢所有关心和支持过ChinaUnix的朋友们 转载本站内容请注明原作者名及出处

清除 Cookies - ChinaUnix - Archiver - WAP - TOP