Java 文档注释

Java 文档注释

目录

Java 文档注释

javadoc 标签

文档注释

javadoc输出什么

实例

Java只是三种注释方式。前两种分别是// 和，第三种被称作说明注释，它以结束。

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

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

javadoc 标签

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

文档注释

在开始的

javadoc输出什么

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

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

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

实例

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

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

import java.io.*; public class SquareNum {      public double square(double num) {      return num * num;   }      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();   }      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.javaLoading source file SquareNum.java...Constructing Javadoc infORMation...Standard Doclet version 1.5.0_13Building 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$

来源地址：https://blog.csdn.net/2301_78835635/article/details/133494286