java教程
  • [java教程]Java 教程
  • [java教程]Java 简介
  • [java教程]Java 开发环境配置
  • [java教程]Java 基础语法
  • [java教程]Java 对象和类
  • [java教程]Java 基本数据类型
  • [java教程]Java 变量类型
  • [java教程]Java 修饰符
  • [java教程]Java 运算符
  • [java教程]Java 循环结构 - for, while 及 do...while
  • [java教程]Java 分支结构 - if...else/switch
  • [java教程]Java Number & Math 类
  • [java教程]Java Character 类
  • [java教程]Java String 类
  • [java教程]Java StringBuffer 和 StringBuilder 类
  • [java教程]Java 数组
  • [java教程]Java 日期时间
  • [java教程]Java 正则表达式
  • [java教程]Java 方法
  • [java教程]Java 流(Stream)、文件(File)和IO
  • [java教程]Java Scanner 类
  • [java教程]Java 异常处理
  • [java教程]Java 继承
  • [java教程]Java Override重写
  • [java教程]Java Overload重载
  • [java教程]Java 多态
  • [java教程]Java 抽象类
  • [java教程]Java 封装
  • [java教程]Java 接口
  • [java教程]Java 包(package)
  • [java教程]Java 数据结构
  • [java教程]Java 集合框架
  • [java教程]Java 泛型
  • [java教程]Java 序列化
  • [java教程]Java 网络编程
  • [java教程]Java 发送邮件
  • [java教程]Java 多线程编程
  • [java教程]Java Applet 基础
  • [java教程]Java 文档注释
  • [java教程]Java 实例
  • [java教程]Java 8 新特性
  • [java教程]Java MySQL 连接
  • 直达腾讯云服务器
    腾讯云服务器,数据库,短信等热销产品限量秒杀;新购爆款3折起;
    腾讯云数据库MySQL入门机型仅12元/月
    腾讯云云服务器新购特惠,最低2折起,1核1G3年仅794.73元,即0.73元/日。
    腾讯云国际顶级CA机构SSL证书8.8折,云解析买一年最高送半年!
    腾讯云为数百万企业和开发者提供安全、稳定的云服务器、云数据库、CDN等云服务
    腾讯云服务器安全可靠高性能,多种配置供您选择
    腾讯云数据库性能卓越稳定可靠,为您解决数据库运维难题
    阿里云服务器入口
    180天免费用腾讯云服务器马上领取
    您当前位置:狗鱼MySQL教程 >> 服务端编程 >> java教程 >> Java 文档注释
    Java 文档注释
    更新日期: 2017年07月14日 来源: 本站原创 作者: 佚名 阅读:
    上一篇Java Applet 基础 下一篇:Java 实例

    java 文档注释

    java 只是三种注释方式。前两种分别是 ///* */,第三种被称作说明注释,它以 /** 开始,以 */结束。

    说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出到html文件中。

    说明注释,使你更加方面的记录你的程序信息。


    javadoc 标签

    javadoc 工具软件识别以下标签:

    标签 描述 示例
    @author 标识一个类的作者
     
    @author description
    @deprecated 指名一个过期的类或成员
     
    @deprecated description
    {@docRoot} 指明当前文档根目录的路径
     
    Directory Path
    @exception 标志一个类抛出的异常
     
    @exception exception-name explanation
    {@inheritDoc} 从直接父类继承的注释
     
    Inherits a comment from the immediate surperclass.
    {@link} 插入一个到另一个主题的链接
     
    {@link name text}
    {@linkplain} 插入一个到另一个主题的链接,但是该链接显示纯文本字体
     
    Inserts an in-line link to another topic.
    @param 说明一个方法的参数
     
    @param parameter-name explanation
    @return 说明返回值类型
     
    @return explanation
    @see 指定一个到另一个主题的链接
     
    @see anchor
    @serial 说明一个序列化属性
     
    @serial description
    @serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据
     
    @serialData description
    @serialField 说明一个ObjectStreamField组件
     
    @serialField name type description
    @since 标记当引入一个特定的变化时
     
    @since release
    @throws 和 @exception标签一样. The @throws tag has the same meaning as the @exception tag.
     
    {@value} 显示常量的值,该常量必须是static属性。 Displays the value of a constant, which must be a static field.
     
    @version 指定类的版本
     
    @version info

    文档注释

    在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。

    之后,你可以包含一个或多个何种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).

    多个相同类型的标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个的放在一起。

    下面是一个类的说明注释的实例:

    /**
    * 这个类绘制一个条形图
    *
    @author noob
    *
    @version 1.2
    */

    javadoc 输出什么

    javadoc 工具将你 Java 程序的源代码作为输入,输出一些包含你程序注释的HTML文件。

    每一个类的信息将在独自的HTML文件里。javadoc 也可以输出继承的树形结构和索引。

    由于 javadoc 的实现不同,工作也可能不同,你需要检查你的 Java 开发系统的版本等细节,选择合适的 Javadoc 版本。

    实例

    下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。

    在经过 javadoc 处理之后,SquareNum 类的注释将在 SquareNum.html 中找到。

    SquareNum.java 文件代码:

    import java.io.*;
    /**
    * 这个类演示了文档注释
    *
    @author Ayan Amhed
    *
    @version 1.2
    */
    public class SquareNum {
    /**
    * This method returns the square of num.
    * This is a multiline description. You can use
    * as many lines as you like.
    *
    @param num The value to be squared.
    *
    @return num squared.
    */
    public double square(double num) { return num * num; }
    /**
    * This method inputs a number from the user.
    *
    @return The value input as a double.
    *
    @exception IOException On input error.
    *
    @see IOException
    */
    public double getNumber() throws IOException {
    InputStreamReader isr = new InputStreamReader(System.in);
    BufferedReader inData = new BufferedReader(isr);
    String str;
    str = inData.readLine();
    return (new Double(str)).doubleValue();
    }
    /**
    *
    This method demonstrates square().
    *
    @param args Unused.
    *
    @return Nothing.
    *
    @exception IOException On input error.
    *
    @see IOException
    */
    public static void main(String args[]) throws IOException {
    SquareNum ob = new SquareNum();
    double val;
    System.out.println("Enter value to be squared: ");
    val = ob.getNumber();
    val = ob.square(val);
    System.out.println("Squared value is " + val);
    }
    }

    如下,使用 javadoc 工具处理 SquareNum.java 文件:

    $ javadoc SquareNum.java
    Loading source file SquareNum.java...
    Constructing Javadoc information...
    Standard Doclet version 1.5.0_13
    Building tree for all the packages and classes...
    Generating SquareNum.html...
    SquareNum.java:39: warning - @return tag cannot be used\
                          in method with void return type.
    Generating package-frame.html...
    Generating package-summary.html...
    Generating package-tree.html...
    Generating constant-values.html...
    Building index for all the packages and classes...
    Generating overview-tree.html...
    Generating index-all.html...
    Generating deprecated-list.html...
    Building index for all classes...
    Generating allclasses-frame.html...
    Generating allclasses-noframe.html...
    Generating index.html...
    Generating help-doc.html...
    Generating stylesheet.css...
    1 warning
    $
     

    感觉本站内容不错,读后有收获?

    我要小额赞助,鼓励提供更好的内容教程

    上一篇Java Applet 基础 下一篇:Java 实例
    Copyright 2013-2017 Powered by 狗鱼MySQL教程,All Rights Reserved.
    广州相如计算机科技有限有限公司 版权所有 粤ICP备08130661号-4
    售前咨询:020-38667011 手机:13711588918