文档注释
2018-01-30 11:31
176 查看
在开始的 / 之后,第一行或几行是关于类、变量和方法的主要描述。
之后,你可以包含一个或多个何种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号().
多个相同类型的标签应该放成一组。例如,如果你有三个 @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 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.bjrongjinhuiyin.com.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
之后,你可以包含一个或多个何种各样的 @ 标签。每一个 @ 标签必须在一个新行的开始或者在一行的开始紧跟星号().
多个相同类型的标签应该放成一组。例如,如果你有三个 @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 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.bjrongjinhuiyin.com.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
相关文章推荐
- [技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档
- PHP 注释文档标记
- eclipse自动生成的get set方法 自动加上文本注释,并且注释内容包含字段中我们加的文档注释 .
- 使用.NET中的XML注释(二) -- 创建帮助文档入门篇
- 文档注释+jar文件生成+jar使用
- Xcode4快速Doxygen文档注释 — 简明图文教程
- 黑马程序员_Java基础 数组、数组工具类、文档注释总结
- 福利整理-如何在XCode 6中利用注释生成文档
- Java中文档注释的模板修改及添加注释的快捷键
- JAVA 文档注释
- Doxygen代码注释规定和生产文档说明
- Java基础--->02.单行注释、多行注释,文档注释和API文档。
- Java 基础入门随笔(9) JavaSE版——文档注释
- 把文档中的//注释应用特殊样式
- 文档注释规范
- Java之利用javadoc生成注释文档
- IOS文档注释
- java文档注释规范
- ndoc2007,生成注释文档,支持泛型,2.0,中文注解,部分汉化
- JAVA 文档注释