Java--文档注释
Java 文档注释
Java只是三种注释方式。前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束。
说明注释允许你在程序中嵌入关于程序的信息。你可以使用javadoc工具软件来生成信息,并输出到HTML文件中。
说明注释,使你更加方便的记录你的程序的信息。
javadoc 标签
javadoc工具软件识别以下标签:
标签 | 描述 | 示例 |
---|---|---|
@author | 标识一个类的作者 | @author description |
@deprecated | 指名一个过期的类或成员 | @deprecated description |
{@docRoot} | 指明当前文档根目录的路径 | Directory Path |
@exception | 标志一个类抛出的异常 | @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 explanation |
@return | 说明返回值类型 | @return explanation |
@see | 指定一个到另一个主题的链接 | @see anchor |
@serial | 说明一个序列化属性 | @serial description |
@serialData | 说明通过writeObject( ) 和 writeExternal( )方法写的数据 | @serialData description |
@serialField | 说明一个ObjectStreamField组件 | @serialField name type description |
@since | 标记当引入一个特定的变化时 | @since release |
@throws | 和 @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 $
转载于:https://www.cnblogs.com/DreamRecorder/p/9228652.html
Java--文档注释相关推荐
- java文档注释 编写格式
java 文档注释 在sun主页上有java文档注释的编写格式 How to Write Doc Comments for the Javadoc Tool http://java.sun.com/j ...
- IDEA JAVA文档注释和方法注释模板
IDEA JAVA文档注释和方法注释模板 文档注释 #if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${ ...
- Java文档注释用法+JavaDoc的使用详解
Java文档注释+JavaDoc的使用详解 简介 文档注释负责描述类.接口.方法.构造器.成员属性.可以被JDK提供的工具 javadoc 所解析,自动生成一套以网页文件形式体现该程序说明文档的注释. ...
- java文档注释报错,java文档注释主要使用方法
一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这 ...
- Java注释详解-Java文档注释生成Java API文档
Java文档注释是一种功能强大的注释形式,如果在你所编写的程序中规范的添加文档注释,那你就可以生成一份系统正规的API文档.Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/. ...
- 如何写Java文档注释(Java Doc Comments)
本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主 ...
- Java文档注释【自制API】
工具类的文档注释 工具类:一般都定义成静态的,只提供工具方法,没有特定数据,不需要构建对象. 为了保证不让其他成员创建对象,将无参的构造函数设置为私有化即可. 源文件: @author 作者 @ver ...
- java文档注释生产api没有注释_如何使用javadoc命令生成api文档,文档注释
/** * 计算器工具类 * * @62616964757a686964616fe78988e69d8331333365646332author GaoHuanjie * @version V1.0 ...
- Java文档注释 - IDEA设置
一. 概述 Java支持三种注释.前两种分别是 单行注释 // 和 多行注释 /* */ ,第三种是 文档注释 /** */. 在IDEA中,文档注释可以对类.接口.方法.属性等进行描述,提高阅读效率 ...
- java文档注释return_Java-文档注释
Java-文档注释 Java语言支持三种类型的注释- Sr.No. Comment & Description 1 /* text */ The compiler ignores everyt ...
最新文章
- Ubuntu中防火墙设置
- 五个方面入手 教你如何成为领导型CIO
- 闪电Android视频转换器,闪电视频转换器
- 计院生活--第二章 深入虎穴(下)
- 读写锁(ReadwriteLock)
- 家人不支持自己学计算机,家人不支持我学习,感觉父母对我好像是很无所谓的?...
- 《精通Android 5 多媒体开发》——第6章,第6.1节视频系统结构
- @vail 判断某字段在范围内_条件判断函数If,你真的会使用吗?实用技巧都掌握吗?...
- [转]神奇选股指标问世,每月稳定获利有保障
- java 事件处理机制
- python rest 框架,[Python自学] restframework
- 【测试】优秀软件测试工程师必备的8个能力
- Failed to decode response: zlib_decode(): data error Retrying with degraded;
- hive表加载csv格式数据或者json格式数据
- ROC-RK3328-CC 开发板开箱和上手指南
- 高德地图上绘制城市名字和带涟漪的点标记
- Web安全基础一漏洞产生原理漏洞探测(持续更新)
- 默默学计算机专转本,专转本计算机默默学
- 汽车结构嵌件市场现状及未来发展趋势
- [Swift通天遁地]八、媒体与动画-(13)CoreText框架实现图文混排
热门文章
- python图片识别训练汽车_python实现图片识别汽车功能
- jQuery动画效果之上卷下拉
- python打印对象地址_Python打印对象的全部属性
- bzoj 2751: [HAOI2012]容易题(easy)
- 树的点分治(HDU 5977 2016ICPC大连 G: Garden of Eden)
- C++bitset二进制有序集
- 快速排序法实战入门(推荐)
- 安卓自定义view全解:初始化,onDraw函数,onMeasure函数,用户手势事件
- 【Proteus仿真8086】将IO接口电路封装成子电路CCT001
- 贺利坚老师汇编课程36笔记:[BX+SI+IDATA]和[BX+DI+IDATA]寻址