为了账号安全,请及时绑定邮箱和手机立即绑定

Java 文档注释.

标签:
Java

文档注释
在开始的 / 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,你可以包含一个或多个何种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号().
多个相同类型的标签应该放成一组。例如,如果你有三个 @see 标签,可以将它们一个接一个的放在一起。
下面是一个类的说明注释的实例:
/
这个类绘制一个条形图

  • @author runoob

  • @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 bjrongjinhuiyin.com 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
      $

点击查看更多内容
TA 点赞

若觉得本文不错,就分享一下吧!

评论

作者其他优质文章

正在加载中
  • 推荐
  • 评论
  • 收藏
  • 共同学习,写下你的评论
感谢您的支持,我会继续努力的~
扫码打赏,你说多少就多少
赞赏金额会直接到老师账户
支付方式
打开微信扫一扫,即可进行扫码打赏哦
今天注册有机会得

100积分直接送

付费专栏免费学

大额优惠券免费领

立即参与 放弃机会
意见反馈 帮助中心 APP下载
官方微信

举报

0/150
提交
取消