Java高级教程第九节:Java 文档注释
一、Java 文档注释
Java 支持三种注释方式。前两种分别是 // 和 /* */,第三种被称作说明注释,它以 /** 开始,以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用 javadoc 工具软件来生成信息,并输出到HTML文件中。
说明注释,使你更加方便的记录你的程序信息。
二、javadoc 标签
javadoc 工具软件识别以下标签:
文档注释
在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,你可以包含一个或多个各种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
多个相同类型的标签应该放成一组。例如,如果你有三个 @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 um) {
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高级教程第十节:Java 实例
免责声明:内容和图片源自菜鸟教程,版权归原作者所有,如有侵犯您的原创版权请告知,我们将尽快删除相关内容。
【免责声明】本文部分系转载,转载目的在于传递更多信息,并不代表本网赞同其观点和对其真实性负责,如涉及作品内容、版权和其它问题,请在30日内与我们联系,我们会予以重改或删除相关文章,以保证您的权益!
Java开发高端课程免费试学
大咖讲师+项目实战全面提升你的职场竞争力
- 海量实战教程
- 1V1答疑解惑
- 行业动态分析
- 大神学习路径图
相关推荐
更多2019-05-30
2019-05-30
2019-05-30
2019-06-13
达内就业喜报
更多>Java开班时间
-
北京 丨 12月25日
火速抢座 -
上海 丨 12月25日
火速抢座 -
广州 丨 12月25日
火速抢座 -
兰州 丨 12月25日
火速抢座 -
杭州 丨 12月25日
火速抢座 -
南京 丨 12月25日
火速抢座 -
沈阳 丨 12月25日
火速抢座 -
大连 丨 12月25日
火速抢座 -
长春 丨 12月25日
火速抢座 -
哈尔滨 丨 12月25日
火速抢座 -
济南 丨 12月25日
火速抢座 -
青岛 丨 12月25日
火速抢座 -
烟台 丨 12月25日
火速抢座 -
西安 丨 12月25日
火速抢座 -
天津 丨 12月25日
火速抢座 -
石家庄 丨 12月25日
火速抢座 -
保定 丨 12月25日
火速抢座 -
郑州 丨 12月25日
火速抢座 -
合肥 丨 12月25日
火速抢座 -
太原 丨 12月25日
火速抢座 -
苏州 丨 12月25日
火速抢座 -
武汉 丨 12月25日
火速抢座 -
成都 丨 12月25日
火速抢座 -
重庆 丨 12月25日
火速抢座 -
厦门 丨 12月25日
火速抢座 -
福州 丨 12月25日
火速抢座 -
珠海 丨 12月25日
火速抢座 -
南宁 丨 12月25日
火速抢座 -
东莞 丨 12月25日
火速抢座 -
贵阳 丨 12月25日
火速抢座 -
昆明 丨 12月25日
火速抢座 -
洛阳 丨 12月25日
火速抢座 -
临沂 丨 12月25日
火速抢座 -
潍坊 丨 12月25日
火速抢座 -
运城 丨 12月25日
火速抢座 -
呼和浩特丨12月25日
火速抢座 -
长沙 丨 12月25日
火速抢座 -
南昌 丨 12月25日
火速抢座 -
宁波 丨 12月25日
火速抢座 -
深圳 丨 12月25日
火速抢座 -
大庆 丨 12月25日
火速抢座