【图灵干货】Java高级教程第九节：Java 文档注释
2021-11-02 16:23:12
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 实例
Java支持三种注解方法。前面两个分别是//和/**/，第三个是说明，以/**开始，以*/结束。
注解使你可以将程序的信息嵌入到程序中。你可以用javadoc工具软件来产生和输出你的HTML文件。
描述注解，这样可以方便地记录程序信息。
javadoc标签。
javadoc工具可以识别下列标签：
javadoc软件可以识别下列标签。
文档注释
在开始/**之后，第一行或几行主要描述类、变量和方法。
然后，您可以包括一个或多个@标签。每个@标签都必须新行开始或一行开始时跟随星号(*).
同一类型的多种标签应被归入一个组。举例来说，如果您有三个@see标签，您可以将它们逐一放在一起。
下面是解释评论评论的实例：
/***画这种类型的条形图。
*@authorunob。
*@version1.2。
*/
javadoc输出什么？
Javadoc工具将Java程序的源码作为输入，输出一些HTML文件，其中有你的程序注释。
每种类型的信息都存在于单独的HTML文件中。javadoc也能够输出树结构和继承的索引。
因为javadoc的实现不同，所做的工作也可能不同，因此需要查看Java开发系统的版本等细节，并选择适当的Javadoc版本。
实例
这里有一个简单的描述注释实例。要注意，每条评论都在它所描述的项目之前。
在javadoc处理之后，在SquareNum.html中可以找到SquareNum.html。
在下一章中，我们将介绍Java高级教程第十节：Java 8 新特性
图灵学院成立于2017年7月15日，现阶段提供 计算机基础原理、JavaSE核心、Java后端、 面试必备算法、python核心编程、数据分析、web 开发题、人工智能等专题课程，为想学习Python的学员提供优质的培训服务，帮助学员掌握更加全面的技能，是计算机人员职场中提职加薪的首选。
免费java架构师视频学习地址：免费视频
