Javadoc注释的用法

 

相关阅读:http://blog.163.com/hui_san/blog/static/5710286720104191100389/

  1. Java 文档

    // 注释一行
    /* ...... */ 注释若干行
    /** ...... */ 注释若干行,并写入 javadoc 文档

    通常这种注释的多行写法如下:

    /**
    * .........
    * .........
    */

    javadoc -d 文档存放目录 -author -version 源文件名.java
    这条命令编译一个名为"源文件名.java"的 java 源文件,并将生成的文档存放在"文档存放目录"指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。

    二. 文档注释的格式

    1. 文档和文档注释的格式化

    生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。
    比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。
    文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如

    /**
    * This is first line. <br>
    ***** This is second line. <br>
    This is third line.
    */

    2. 文档注释的三部分
    先举例如下

    /**
    * show
    方法的简述.
    * <p>show 方法的详细说明第一行<br>
    * show 方法的详细说明第二行
    * @param b true 表示显示,false 表示隐藏
    * @return 没有返回值

    */

    public
    void show(boolean b) {
    frame.show(b);
    }

    第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明

    简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。

    第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。

    * show 方法的简述.
    * <p>show 方法的详细说明第一行<br>
    * show 方法的详细说明第二行

    简述也在其中。这一点要记住了

    第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
    * @param b true 表示显示,false 表示隐藏
    * @return 没有返回值

    三. 使用 javadoc 标记
    javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
    javadoc 标记有如下一些:
    @author 标明开发该类模块的作者

    @version 标明该类模块的版本

    @see 参考转向,也就是相关主题

    @param 对方法中某参数的说明

    @return 对方法返回值的说明

    @exception 对方法可能抛出的异常进行说明


    @author 作者名
    @version 版本号
    其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效

    使用 @param、@return 和 @exception 说明方法
    这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:
    @param 参数名参数说明
    @return 返回值说明
    @exception 异常类名说明

    四. javadoc 命令
    用法:
      javadoc [options] [packagenames] [sourcefiles]

    选项:

    -public 仅显示 public 类和成员

    -protected 显示 protected/public 类和成员 (缺省)
    -package 显示 package/protected/public 类和成员

    -private 显示所有类和成员

    -d <directory> 输出文件的目标目录

    -version 包含 @version 段

    -author 包含 @author 段

    -splitindex 将索引分为每个字母对应一个文件

    -windowtitle <text> 文档的浏览器窗口标题


    javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:

      fancy.Editor
      fancy.Test
      fancy.editor.ECommand
      fancy.editor.EDocument
      fancy.editor.EView

    可以直接编译类:
    javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java

    也可以是给出包名作为编译参数,如:javadoc fancy fancy.editor
    可以自己看看这两种方法的区别

    到此为止javadoc就简单介绍完了,想要用好她还是要多用,多参考标准java代码(可参考JDK安装目录下的src源文件包)

Javadoc注释的用法的更多相关文章

  1. 【Java学习笔记之十八】Javadoc注释的用法

    Javadoc注释的用法 Java 文档 // 注释一行/* ...... */ 注释若干行/** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /*** ...

  2. 房上的猫:JavaDoc注释

    //这是一个注释 /*   *这是一个演示程序   */ /**    *@这是JavaDoc注释.   */ JavaDoc注释 背景: javadoc是Sun公司提供的一个技术,它从程序源代码中抽 ...

  3. Jindent——让intellij idea 像eclipse一样生成模版化的javadoc注释

    插件地址 http://plugins.jetbrains.com/plugin/2170?pr=idea 安装方法参考 http://www.cnblogs.com/nova-/p/3535636. ...

  4. javadoc 和 javadoc注释规范

    javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档. javadoc命令是用来生成自己API文档的,使用方式:在dos中在目标文件所 ...

  5. javadoc注释规范

    javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: / ...

  6. java注释详解--javadoc注释

    一. Java注释分类// 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ...... ...

  7. javaDoc 注释规范

    Javadoc虽然是Sun公司为Java文档自动生成设计的,可以从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档.但是Javadoc的注释也符合C的注释格式,而且doxyen ...

  8. hibernate注解(自动建表如何有表DDL注释) -- Comment用法

    import java.io.Serializable; import java.sql.Date; import java.sql.Timestamp; import javax.persisten ...

  9. Eclipse中给jar包导入JavaDoc注释文档的方法

    原文链接:http://www.apkbus.com/android-124056-1-1.html 第一步:将jar加入到Referenced Libraries 右键点击jar --> 选择 ...

随机推荐

  1. C++11中rvalue references的使用

    Rvalue references are a feature of C++ that was added with the C++11 standard. The syntax of an rval ...

  2. express操作数据库

    Express 首页 入门 使用指南 API 中文手册 进阶话题 有用的资源 集成数据库 为 Express 应用添加连接数据库的能力,只需要加载相应数据库的 Node.js 驱动即可.这里将会简要介 ...

  3. 「日常训练」 Mike and Frog (CFR305D2C)

    题意与分析 (Codeforces 548C) 我开始以为是一条数学题,死活不知道怎么做,无奈看题解,才知这是一条暴力,思维江化了- - 题意大概是这样的: 两个东西的初始高度分别为h1,h2&quo ...

  4. jmeter+ant的使用

    1.安装ant 下载ant,解压到某盘 2.配置环境变量: 变量名称 变量值 备注 ANT_HOME F:\apache-ant-1.10.3 Ant的解压路径 Path %ANT_HOME%\bin ...

  5. IDEA + Maven + SSM 框架整合步骤

    因为前段时间自己想写个SSM的demo,然而不知怎么回事,配置完之后出现错误,怎么都调不好.最后从朋友那里拷了一个SSM的demo过来搭建成功,写这篇东西也是为了以后如果还有需要可以方便的查阅,并且也 ...

  6. CSP201403-1:相反数

    引言:CSP(http://www.cspro.org/lead/application/ccf/login.jsp)是由中国计算机学会(CCF)发起的“计算机职业资格认证”考试,针对计算机软件开发. ...

  7. Datenode无法启动

    执行start-dfs.sh后,或者执行datenode没有启动.很大一部分原因是因为在第一次格式化dfs后,启动并使用了hadoop,后来又重新执行了格式化命令 这时主节点namenode的clus ...

  8. 1.16. BIP39协议:使用助记词生成确定性钱包

    以太坊系统学习教程: https://www.netkiller.cn/blockchain/bip39.html 1.16. BIP39协议:使用助记词生成确定性钱包 BIP:39 层:应用层 标题 ...

  9. lintcode-49-字符大小写排序

    49-字符大小写排序 给定一个只包含字母的字符串,按照先小写字母后大写字母的顺序进行排序. 注意事项 小写字母或者大写字母他们之间不一定要保持在原始字符串中的相对位置. 样例 给出"abAc ...

  10. PAT 1040 有几个PAT

    https://pintia.cn/problem-sets/994805260223102976/problems/994805282389999616 字符串 APPAPT 中包含了两个单词 PA ...