微商城网站建设哪家好,房屋设计说明,3d建模教程人物,自己怎么做返利网站吗Java 文档注释
目录
Java 文档注释
javadoc 标签 文档注释
javadoc输出什么
实例 Java只是三种注释方式。前两种分别是// 和/* */#xff0c;第三种被称作说明注释#xff0c;它以/** 开始#xff0c;以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使…Java 文档注释
目录
Java 文档注释
javadoc 标签 文档注释
javadoc输出什么
实例 Java只是三种注释方式。前两种分别是// 和/* */第三种被称作说明注释它以/** 开始以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息并输出到HTML文件中。
说明注释是你更加方面的记录你的程序的信息。 javadoc 标签
javadoc工具软件识别以下标签
标签描述示例author标识一个类的作者author descriptiondeprecated指名一个过期的类或成员deprecated description{docRoot}指明当前文档根目录的路径Directory Pathexception标志一个类抛出的异常exception exception-name explanation{inheritDoc}从直接父类继承的注释Inherits a comment from the immediate surperclass.{link}插入一个到另一个主题的链接{link name text}{linkplain}插入一个到另一个主题的链接但是该链接显示纯文本字体Inserts an in-line link to another topic.param说明一个方法的参数param parameter-name explanationreturn说明返回值类型return explanationsee指定一个到另一个主题的链接see anchorserial说明一个序列化属性serial descriptionserialData说明通过writeObject( ) 和 writeExternal( )方法写的数据serialData descriptionserialField说明一个ObjectStreamField组件serialField name type descriptionsince标记当引入一个特定的变化时since releasethrows和 exception标签一样.The throws tag has the same meaning as the exception tag.{value}显示常量的值该常量必须是static属性。Displays the value of a constant, which must be a static field.version指定类的版本version info 文档注释
在开始的/**之后第一行或几行是关于类、变量和方法的主要描述.
之后你可以包含一个或多个何种各样的标签。每一个标签必须在一个新行的开始或者在一行的开始紧跟星号(*).
多个相同类型的标签应该放成一组。例如如果你有三个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
$
