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

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

📁 javn的Java书籍JAVA集合框架.rar我看过了是很有帮助的
💻 HTM
📖 第 1 页 / 共 5 页
字号:
      <VAR>class-name</VAR> 是该方法可抛出的异常名。如果该类不是全限定的,则 Javadoc 使用 <A 
      href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#seesearchorder">搜索次序</A> 
      查找该类。
      <P><A name=@version></A></P>
      <DT><B><CODE>@version</CODE></B> <VAR>version-text</VAR> 
      <DD>当使用 -version 选项时用 <VAR>version-text</VAR> 
      指定的内容给生成文档添加“版本”子标题。该文本没有特殊内部结构。文档注释最多只能包含一个 <CODE>@version</CODE> 
      标记。版本通常是指包含该类或成员的软件(例如 JDK)版本。 </DD></DL></DD></DL></BLOCKQUOTE>
<P><BR><!-- ==================== WHERE TAGS CAN BE USED ===================== --><A 
name=wheretags></A></P>
<H2>可使用标记的地方</H2>
<BLOCKQUOTE>
  <P>下面介绍了在哪些地方可使用标记。注意这四个标记可用于所有文档注释中:<CODE>@see</CODE>、<CODE>@link</CODE>、<CODE>@since</CODE>、<CODE>@deprecated</CODE>。</P>
  <P><BR><A name=overviewtags></A></P>
  <H3>概述文档标记</H3>
  <P>概述标记可出现在概述页的文档注释中(该文档通常位于叫作 <CODE>overview.html</CODE> 
  的源文件中)。像在任何其他文档注释中一样,这些标记必须位于描述后面。</P>
  <P><B>注意</B> - <CODE>{@link}</CODE> 标记在 JDK 1.2 的概述文档中有一个 bug -- 
  文档正确显示,但没有链接。</P>
  <TABLE cellSpacing=0 cellPadding=3 border=1>
    <TBODY>
    <TR bgColor=#cccccc>
      <TD><B>概述标记</B> </TD></TR>
    <TR>
      <TD>
        <TABLE border=0>
          <TBODY>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@see"><CODE>@see</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#{@link}"><CODE>{@link}</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@since"><CODE>@since</CODE></A> 
            </TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
  <P><BR><A name=packagetags></A></P>
  <H3>包文档标记</H3>
  <P>包标记可出现在包的文档注释中(该文档位于叫作 <CODE>package.html</CODE> 的源文件中)。</P>
  <TABLE cellSpacing=0 cellPadding=3 border=1>
    <TBODY>
    <TR bgColor=#cccccc>
      <TD><B>包标记</B> </TD></TR>
    <TR>
      <TD>
        <TABLE border=0>
          <TBODY>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@see"><CODE>@see</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#{@link}"><CODE>{@link}</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@since"><CODE>@since</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@deprecated"><CODE>@deprecated</CODE></A></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
  <P><BR><A name=classtags></A></P>
  <H3>类和接口文档标记</H3>
  <P>下面是可出现在类或接口的文档注释中的标记。</P>
  <TABLE cellSpacing=0 cellPadding=3 border=1>
    <TBODY>
    <TR bgColor=#cccccc>
      <TD><B>类/接口标记</B> </TD></TR>
    <TR>
      <TD>
        <TABLE border=0>
          <TBODY>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@see"><CODE>@see</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#{@link}"><CODE>{@link}</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@since"><CODE>@since</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@deprecated"><CODE>@deprecated</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@author"><CODE>@author</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@version"><CODE>@version</CODE></A></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
  <H4>类注释示例:</H4><PRE>/**
 * 代表屏幕上窗口的类。
 * 例如:
 * &lt;pre&gt;
 *    Window win = new Window(parent);
 *    win.show();
 * &lt;/pre&gt;
 *
 * @author  Sami Shaio
 * @version 1.7, 06/25/99
 * @see     java.awt.BaseWindow
 * @see     java.awt.Button
 */
class Window extends BaseWindow {
   ...
}
</PRE>
  <P><BR><A name=fieldtags></A></P>
  <H3>域文档标记</H3>
  <P>下面是可出现在域文档注释中的标记。</P>
  <TABLE cellSpacing=0 cellPadding=3 border=1>
    <TBODY>
    <TR bgColor=#cccccc>
      <TD><B>域标记</B> </TD></TR>
    <TR>
      <TD>
        <TABLE border=0>
          <TBODY>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@see"><CODE>@see</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#{@link}"><CODE>{@link}</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@since"><CODE>@since</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@deprecated"><CODE>@deprecated</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@serial"><CODE>@serial</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@serialField"><CODE>@serialField</CODE></A></TD></TR></TBODY></TABLE></TD></TR></TBODY></TABLE>
  <H4>域注释示例:</H4><PRE>    /**
     * 组件的 X 坐标。
     *
     * @see #getLocation()
     */
    int x = 1263732;
</PRE>
  <P><BR><A name=methodtags></A></P>
  <H3>构造函数和方法文档标记</H3>
  <P>下面是可出现在构造函数或方法的文档注释中的标记。</P>
  <TABLE cellSpacing=0 cellPadding=3 border=1>
    <TBODY>
    <TR bgColor=#cccccc>
      <TD><B>方法/构造函数标记</B> </TD></TR>
    <TR>
      <TD>
        <TABLE border=0>
          <TBODY>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@see"><CODE>@see</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#{@link}"><CODE>{@link}</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@since"><CODE>@since</CODE></A> 
            </TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@deprecated"><CODE>@deprecated</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@param"><CODE>@param</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@return"><CODE>@return</CODE></A></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@throws"><CODE>@throws</CODE></A> 
              <CODE>(@exception)</CODE></TD></TR>
          <TR>
            <TD><A 
              href="http://www.iplab.is.tsukuba.ac.jp/~liuxj/jdk1.2/zh/docs/tooldocs/solaris/javadoc.html#@serialData"><CODE>@serialData</CODE></A>

⌨️ 快捷键说明

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