Java 教程
- 第1节:Java 简介
- 第2节:Java 开发环境配置
- 第3节:Java 基础语法
- 第4节:Java 对象和类
- 第5节:Java 基本数据类型
- 第6节:Java 变量类型
- 第7节:Java 修饰符
- 第8节:Java 运算符
- 第9节:Java 循环结构 - for, while 及 do…while
- 第10节:Java 分支结构 - if…else/switch
- 第11节:Java Number类
- 第12节:Java Character类
- 第13节:Java String类
- 第14节:Java StringBuffer 和 StringBuilder 类
- 第15节:Java 数组
- 第16节:Java 日期时间
- 第17节:Java 正则表达式
- 第18节:Java 方法
- 第19节:Java 流(Stream)、文件(File)和IO
- 第20节:Java Scanner 类
- 第21节:Java 异常处理
- 第22节:Java 继承
- 第23节:Java 重写(Override)与重载(Overload)
- 第24节:Java 多态
- 第25节:Java 抽象类
- 第26节:Java 封装
- 第27节:Java 接口
- 第28节:Java 包(package)
- 第29节:Java 数据结构
- 第30节:Java 集合框架
- 第31节:Java 泛型
- 第32节:Java 序列化
- 第33节:Java 网络编程
- 第34节:Java 发送邮件
- 第35节:Java 多线程编程
- 第36节:Java Applet基础
- 第37节:Java 文档注释
- 第38节:Java 8 新特性
- 第39节:Java 9 新特性
- 第40节:Java 10 新特性
Java 文档注释
Java支持三种注释方式。前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息,并输出到HTML文件中。
说明注释,使你更加方便的记录你的程序的信息。
javadoc 标签
javadoc工具软件识别以下标签:
文档注释
在开始的/**之后,第一行或几行是关于类、变量和方法的主要描述.
之后,你可以包含一个或多个何种各样的@标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
多个相同类型的标签应该放成一组。例如,如果你有三个@see标签,可以将它们一个接一个的放在一起。
下面是一个类的说明注释的示例:
/*** This class draws a bar chart.
* @author Zara Ali
* @version 1.2
*/
javadoc输出什么
javadoc工具将你Java程序的源代码作为输入,输出一些包含你程序注释的HTML文件。
每一个类的信息将在独自的HTML文件里。javadoc也可以输出继承的树形结构和索引。
由于javadoc的实现不同,工作也可能不同,你需要检查你的Java开发系统的版本等细节,选择合适的Javadoc版本。
实例
下面是一个使用说明注释的简单实例。注意每一个注释都在它描述的项目的前面。
在经过javadoc处理之后,SquareNum类的注释将在SquareNum.html中找到。
import java.io.*;
/**
* This class demonstrates documentation comments.
* @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
$