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. java.lang.NoClassDefFoundError 错误解决思路

    Process: com.oppo.reader, PID: 20472 java.lang.NoClassDefFoundError: com.zhangyue.iReader.PDF2.ui.PD ...

  2. 洛谷P1364 医院设置

    LITTLESUN的第一道图论,撒花~~ 题目链接 这道题是Floyd的板子题 注意对于矩阵图的初始值赋值要全部赋值成最大值 十六进制的最大值表示方式是0x3f3f3f3f memset(G,0x3f ...

  3. javac一次性编译多个包下的.java文件

    如题是我想要知道的,然后在网上搜了一下 下面是在某些帖子里看到别人说的只言片语 =========================================================== ...

  4. Prometheus 普罗米修斯监控

    周末在家无聊 看新闻 看到关于监控的东西 拿来玩玩 试一下 感觉还蛮有意思 特此记录一下 这里只介绍客户端的配置 1:首先在POM中添加依赖 <dependency> <groupI ...

  5. 测试理论--branch testing and boundary testing

    1 branch testing 分支测试 测试代码的所有分支 2 boundary testing 测试 程序的限制条件

  6. [问题解决]Python locale error: unsupported locale setting

    原文来源:https://stackoverflow.com/questions/14547631/python-locale-error-unsupported-locale-setting 安装f ...

  7. 转---详细的Android开发环境搭建教程

    五步搞定Android开发环境部署——非常详细的Android开发环境搭建教程 引言   在windows安装Android的开发环境不简单也说不上算复杂,本文写给第一次想在自己Windows上建立A ...

  8. 【工作感悟】——揭开“PM”的面纱

    [前言] 上次跟大家分享了面试的故事,小编觉得效果还不错,因此小编决定把工作感悟系列写下去,不过时间就不好说了.希望小伙伴们在评论列表中发表自己的看法和观点,积极参与啦~~ [背景] 初来Y公司,作为 ...

  9. qemu的配置

    qemu的配置: buildroot的配置不需要多做配置,对了,设置下生成的文件系统是rootfs.ext2 内核打开virtio qemu脚本会在后面 疑问: 1)为什么qemu启动起来之后,没有e ...

  10. Java中输入输出流

    InputStream:所有字节输入流的所有类的超类. read(byte[] b)从输入流中读取一定数量的字节,并将其存储在缓冲数组b中 reset()将此流重新定位到最后一次对此流调用mark方法 ...