Java注释link_Java文档注释

Java只是三种注释方式。前两种分别是// 和/* */&＃xff0c;第三种被称作说明注释&＃xff0c;它以/** 开始&＃xff0c;以 */结束。

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

说明注释&＃xff0c;是你更加方面的记录你的程序的信息。

javadoc 标签

javadoc工具软件识别以下标签&＃xff1a;标签描述示例

&＃64;author标识一个类的作者&＃64;author description

&＃64;deprecated指名一个过期的类或成员&＃64;deprecated description

{&＃64;docRoot}指明当前文档根目录的路径Directory Path

&＃64;exception标志一个类抛出的异常&＃64;exception exception-name explanation

{&＃64;inheritDoc}从直接父类继承的注释Inherits a comment from the immediate surperclass.

{&＃64;link}插入一个到另一个主题的链接{&＃64;link name text}

{&＃64;linkplain}插入一个到另一个主题的链接&＃xff0c;但是该链接显示纯文本字体Inserts an in-line link to another topic.

&＃64;param说明一个方法的参数&＃64;param parameter-name explanation

&＃64;return说明返回值类型&＃64;return explanation

&＃64;see指定一个到另一个主题的链接&＃64;see anchor

&＃64;serial说明一个序列化属性&＃64;serial description

&＃64;serialData说明通过writeObject( ) 和 writeExternal( )方法写的数据&＃64;serialData description

&＃64;serialField说明一个ObjectStreamField组件&＃64;serialField name type description

&＃64;since标记当引入一个特定的变化时&＃64;since release

&＃64;throws和 &＃64;exception标签一样.The &＃64;throws tag has the same meaning as the &＃64;exception tag.

{&＃64;value}显示常量的值&＃xff0c;该常量必须是static属性。Displays the value of a constant, which must be a static field.

&＃64;version指定类的版本&＃64;version info

文档注释

在开始的/**之后&＃xff0c;第一行或几行是关于类、变量和方法的主要描述.

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

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

下面是一个类的说明注释的示例&＃xff1a;/*** This class draws a bar chart.

* &＃64;author Zara Ali

* &＃64;version 1.2*/

javadoc输出什么

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

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

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

实例

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

在经过javadoc处理之后&＃xff0c;SquareNum类的注释将在SquareNum.html中找到。import java.io.*;

/*** This class demonstrates documentation comments.

* &＃64;author Ayan Amhed

* &＃64;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.

* &＃64;param num The value to be squared.

* &＃64;return num squared.

*/

public double square(double num) {

return num * num;

}

/**

* This method inputs a number from the user.

* &＃64;return The value input as a double.

* &＃64;exception IOException On input error.

* &＃64;see IOException

*/

public double getNumber() throws IOException {

InputStreamReader isr &＃61; new InputStreamReader(System.in);

BufferedReader inData &＃61; new BufferedReader(isr);

String str;

str &＃61; inData.readLine();

return (new Double(str)).doubleValue();

}

/**

* This method demonstrates square().

* &＃64;param args Unused.

* &＃64;return Nothing.

* &＃64;exception IOException On input error.

* &＃64;see IOException

*/

public static void main(String args[]) throws IOException

{

SquareNum ob &＃61; new SquareNum();

double val;

System.out.println("Enter value to be squared: ");

val &＃61; ob.getNumber();

val &＃61; ob.square(val);

System.out.println("Squared value is " &＃43; val);

}

}

如下&＃xff0c;使用javadoc工具处理SquareNum.java文件&＃xff1a;$ 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 - &＃64;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

$

本文来自投稿&＃xff0c;不代表访得立场&＃xff0c;如若转载&＃xff0c;请注明出处&＃xff1a;http://www.found5.com//view/440.html