⭐ 欢迎来到虫虫下载站！ | 📦 资源下载 📁 资源专辑 ℹ️ 关于我们
⭐ 虫虫下载站
📤 上传资源

📄 javadoc- java api 文档生成器.htm

📁 javn的Java书籍JAVA集合框架.rar我看过了是很有帮助的
💻 HTM
📖 第 1 页 / 共 5 页
字号:
🔍
12345 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- saved from url=(0085)http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html -->
<HTML><HEAD><TITLE>javadoc- Java API 文档生成器</TITLE>
<META http-equiv=Content-Type content="text/html; CHARSET=gb2312">
<META content="MSHTML 6.00.2800.1106" name=GENERATOR></HEAD>
<BODY bgColor=#ffffff>
<H1>javadoc - Java API 文档生成器</H1>
<BLOCKQUOTE>
  <P>从 Java 源文件生成 API 文档 HTML 页。</P></BLOCKQUOTE>
<HR>

<H2>目录</H2>
<UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#synopsis">结构</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#description">说明</A></B> 

  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentation">相关文档</A> 

    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#doclets">Javadoc 
    Doclets</A> 
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#terminology">术语</A> 
    </LI></UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#sourcefiles">源文件</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#generatedfiles">生成的文件</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentationcomments">文档注释</A></B> 

  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#comments">注释源代码</A> 
    </LI></UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#javadoctags">Javadoc 
  标记</A></B> 
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#wheretags">使用标记的地方</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#argumentfile">命令行参数文件</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#options">选项</A></B> 

  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#javadocoptions">Javadoc 
    选项</A> 
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#standard">标准 
    Doclet 提供的选项</A> </LI></UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#examples">简单示例</A></B> 

  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingpackages">建立包的文档</A> 

    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingclasses">建立类的文档</A> 

    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingboth">建立包和类的文档</A> 
    </LI></UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#realworldexample">实际示例</A></B> 

  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#environment">环境</A></B> 

  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#classpathenvironment">CLASSPATH</A> 
    </LI></UL>
  <LI><B><A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#seealso">参阅</A></B> 
  </LI></UL>
<HR>
<!-- ==================== SYNOPSIS ======================= -->
<P><A name=synopsis></A></P>
<H2>结构</H2>
<BLOCKQUOTE><PRE><STRONG>javadoc</STRONG> [ <A href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#options">options</A> ] [ packagenames ] [ sourcefiles ] [ <A href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#argumentfile">@files</A> ]
</PRE>
  <P>参数可按任意次序排列。<BR></P>
  <BLOCKQUOTE>
    <DL>
      <DT><A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#options"><CODE>options</CODE></A> 

      <DD>命令行选项，如本文档中所指定。要了解 javadoc 选项的典型用法，参见<A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#realworldexample">实际示例</A>。 

      <DT><CODE>packagenames</CODE> 
      <DD>一系列包的名字，用空格分隔，例如 <CODE>java.lang java.lang.reflect 
      java.awt</CODE>。必须分别指定想要为之建立文档的每一个包。Javadoc 不递归地作用于子包。不允许使用通配符，如（*）。参见<A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingpackages">示例 
      - 建立包的文档</A> 
      <DT><CODE>sourcefiles</CODE> 
      <DD>一系列源文件名，用空格分隔。源文件名可包括路径和通配符如（*）。例如：<CODE>Button.java 
      /home/src/java/awt/Graphics*.java</CODE> 参见<A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingclasses">示例 
      - 建立类的文件</A>。还可混合包名和源文件，如 <A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingboth">示例 
      - 建立包和类的文档</A> 中所示。 
      <DT><A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#argumentfile"><CODE>@files</CODE></A> 

      <DD>以任何次序包含包名和源文件的一个或多个文件。<IMG src=""> </DD></DL></BLOCKQUOTE></BLOCKQUOTE>
<P><BR><!-- =================== DESCRIPTION ======================= --><A 
name=description></A></P>
<H2>说明</H2>
<BLOCKQUOTE><B>
  <P>Javadoc</B> 解析 Java 源文件中的声明和文档注释，并产生相应的 HTML 
  页（缺省），描述公有类、保护类、内部类、接口、构造函数、方法和域。</P>
  <P>可对 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingpackages">整个包</A>、<A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingclasses">单个源文件</A> 
  或 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#documentingboth">二者</A> 
  运行 Javadoc。在第一种情况中，将一系列包名作为参数传递给 
  <CODE>javadoc</CODE>。在第二种情况中，传递一系列源（<CODE>.java</CODE>）文件名。在本文档最后给出了 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#examples">示例</A>。</P>
  <P>在实现时，Javadoc 要求且依赖于 java 编译器完成其工作。Javadoc 调用部分 <CODE>javac</CODE> 
  编译声明部分，忽略成员实现。它建立类的内容丰富的内部表示，包括类层次和“使用”关系，然后从中生成 HTML。Javadoc 还从源代码的 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#comments">文档注释</A> 
  中获得用户提供的文档。</P>
  <P>实际上，Javadoc 将在不带方法体的纯 stub 文件的 <CODE>.java</CODE> 源文件上运行。这意味着可以在创建 API 
  的最早期阶段，在编写任何代码之前，就可编写文档注释并运行 Javadoc。</P>
  <P>完全对应于实际的实现，这些实现可能有赖于隐式的（而非显式的）源代码。例如，Javadoc 将建立在 <CODE>.class</CODE> 
  文件中存在但在源代码中不存在的<A 
  href='http://java.sun.com/docs/books/jls/html/8.doc.html#16823"'> 
  缺省构造函数</A>（<I>Java 语言规范</I> 的第 8.6.7 节）的文档。</P>
  <P>当 Javadoc 建立其内部文档结构时，它将加载所有引用的类。由于这一点，Javadoc 
  必须能查找到所有引用的类，包括引导类、扩展类和用户类。有关详细信息，参见 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/findingclasses.html">如何查找类</A>。一般而言，所创建的类必须加载为扩展或位于 
  Javadoc 的类路径中。</P>
  <P><!-- ====================== DOCLETS ========================= --><A 
  name=doclets></A></P>
  <H3>Javadoc Doclets</H3>
  <P>可使用 doclets 自定义 Javadoc 输出的内容和格式。Javadoc 具有一个缺省的“内嵌”doclet，叫作标准 doclet，它生成 
  HTML-格式的 API 文档。用户可修改或扩展标准 doclet，或编写自己的 doclet 以生成 HTML、XML、MIF、RTF 
  或想要的任何输出格式。关于 doclets 及其用法的信息位于下列位置： 
  <UL>
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/javadoc/index.html">Javadoc 
    Doclets</A> 
    <LI><A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#doclet"><CODE>-doclet</CODE> 
    命令行选项</A> </LI></UL>
  <P>当没有用 <TT>-doclet</TT> 命令行选项指定自定义 doclet 时，Javadoc 将使用缺省的标准 doclet。不管使用哪个 
  doclet，javadoc 工具都有几个命令行选项可用。标准 doclet 还添加了额外的命令行选项集。两个选项集都将在下面的 <A 
  href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#options">选项</A> 
  一节中介绍。<!-- ====================== DOCUMENTATION ========================= --> 
  <A name=documentation></A></P>
  <H3>相关文档</H3>
  <UL>
    <LI>有关 Javadoc 1.2 中增强功能的详细信息，参见 <A 
    href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/javadoc/index.html">Javadoc 
    增强</A>。 
    <LI>有关常问问题的答案、关于 Javadoc 相关工具的信息以及 bug 的解决方案，参见 <A 
    href="http://java.sun.com/products/jdk/javadoc/faq.html">Javadoc FAQ</A>。 
    <LI>有关如何编写文档注释的信息，参见 <A 
    href="http://java.sun.com/products/jdk/javadoc/writingdoccomments.html">如何为 
    Javadoc 编写文档注释</A>。 </LI></UL><!-- ====================== TERMINOLOGY ========================= -->
  <P><A name=terminology></A></P>
  <H3>术语</H3>
  <P>在 Javadoc 环境中，有些术语具有特定的意义： 
  <DL>
    <P><A name=generateddocument></A></P>
    <DT><I>生成的文档</I> 
    <DD>由 javadoc 工具根据 Java 源代码中文档注释生成的文档。缺省的生成文档是 HTML 格式，并由标准 doclet 生成。
    <P><A name=name></A></P>
    <DT><I>名字</I> 
    <DD>Java 语言中的名字，通常为包、类、接口、域、构造函数或方法的名字。名字可以是完全限定的，例如 
    <CODE>java.lang.String.equals(java.lang.Object)</CODE>，也可是部分限定的，例如 
    <CODE>equals(Object)</CODE>。
    <P><A name=documentedclasses></A></P>
    <DT><I>带文档的类</I> 
    <DD>在 javadoc 运行期间为之生成了全部文档的类和接口。要生成文档，源文件必须可用，并且其源文件名或包名必须传递到 javadoc 
    命令中。我们还将这些类称为在 javadoc 运行中包含的类，或<I>包含的类</I>。
    <P><A name=referencedclasses></A></P>
12345

⌨️ 快捷键说明

复制代码 Ctrl + C
搜索代码 Ctrl + F
全屏模式 F11
切换主题 Ctrl + Shift + D
显示快捷键 ?
增大字号 Ctrl + =
减小字号 Ctrl + -