- java数组入门教程
- java数组的遍历
- 基于debian(ubuntu)的JDK安装与卸载-vps环境搭建实录(一)
- java环境变量配置(windows7系统)
- java开发环境配置
- 第一个java程序 helloword
- 使用eclipse快速开发java程序
- Java基础语法
- Java对象和类
- Java基本数据类型
- Java变量类型
- Java修饰符
- Java运算符
- Java循环结构 – for, while 及 do…while
- Java分支结构 – if…else/switch
- Java Number类
- Java Character类
- Java String类
- Java日期时间
- java异常处理分类
- java Exception异常处理实例
- java.util.UUID 工具类详解
- java数字格式化类DecimalFormat详解
- JDBC系列教程之一:jdbc简单介绍
- JDBC系列教程之二:jdbc连接数据的步骤
- JDBC系列教程之三:JDBC基本的CRUD(创建、读取、更新、删除)
- JDBC系列教程之四:SQL注入PreparedStatement和Statement
- JDBC系列教程之五:数据类型
- JDBC系列教程之六:一个简单用户相关的数据访问层
- JDBC系列教程之七:用配置文件(properties)和反射实现与具体类的耦合
- JDBC系列教程之八:事务-ACID
- JDBC系列教程之九:事务-SavePoint与JTA
- JDBC系列教程之十:隔离级别
- JDBC系列教程之十一:其他的几个API
- JDBC系列教程之十二:DatabaseMetaData(数据库的元数据信息)和ParameterMetaData(参数的元数据信息)
- JDBC系列教程之十三:ResultSetMetaData
- JDBC系列教程之十四:用反射ResultSetMetaData将查询结果读入对象中
- JDBC系列教程之十五:数据源和连接池
- Java 继承
- Java 重写(Override)与重载(Overload)
- Java 多态
- Java 抽象类
- java 封装
- Java 接口
- Java 包(package)
- Java 数据结构
- Java 集合框架
- Java 泛型
- Java序列化
- Java 网络编程
- Java 发送邮件
- Java 多线程编程
- Java Applet基础
- Java 文档注释
知识点
相关文章
更多最近更新
更多Java 文档注释
2019-03-28 22:39|来源: 网络
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 $
相关问答
更多-
怎样制作表格在计算机中[2022-09-03]
文档 -
java文档怎么写[2021-10-30]
“奇怪的是,”我在喝完一杯茶,接过第二杯的当儿开始说,“奇怪的是习惯如何形成我们的趣味和思想,很多人就不能想象,像您,希刺克厉夫先生,所过的这么一种与世完全隔绝的生活里也会有幸福存在。可是我敢说,有您一家人围着您,还有您可爱的夫人作为您的家庭与您的心灵上的主宰——” -
976598641@qq.com, 给我发个邮箱地址吧, 给你发个 教程,里面有大量 3D开发的例子。我起步就看的这个。 《 Android3D游戏开发技术详解与典型案例》 60M大小。
-
如何使用java驱动程序在mongodb中的嵌入文档中推送注释(how to push a comment in an embedded document in mongodb with java driver)[2022-01-30]
你需要匹配postId 1,然后将新评论推送到“评论”,如下所示: db.[your collection name].update({"RoomPost" :{$elemMatch :{"postId" : 1}}}, {$push : {"RoomPost.$.comments": {"comment3" :"some comment"}}}) 使用java驱动程序编写它很容易,'update'部分是这样的: BasicDBObject update = new BasicDBObject("$pu ... -
文档注释在C#中:什么是技术原因更喜欢///或/ **(Documentation comments in C#: What are technical reasons to prefer /// or /**)[2022-10-13]
Info自发布此问题以来,我已经能够收集信息,证实即使csc /doc:将接受任一格式,但单行格式与多行格式相比具有一些优势: 1)在Visual Studio中,无论您最初是使用///或/ **记录您的方法,IntelliSense都会为您提供信息,说明您在输入时在方法调用表达式中传递的参数。 但是,只有在使用///格式时,Visual Studio才会为使用预填写的文档注释提供支持。 例如,如果将光标放在Visual Studio中的方法声明上方,然后按/三次,则会看到为您生成的特定于上下文的模板,如下 ... -
@Documented是元注释。 在定义注解时应用@Documented ,以确保使用注释的类在其生成的JavaDoc中显示。 我没有看到太多的用处,但这里有一个例子 。 一个较早的问题表明它在Eclipse中无法自动工作 ,但是我已经在Eclipse 3.6中进行了测试,而且我的注释出现在JavaDoc弹出窗口中,无论我是否附加了@Documented注释。 这里有一个Spring的例子,它确保事务方法在JavaDoc中被标记为: @Target({ElementType.METHOD, ElementT ...
-
Java注释(Java Annotations)[2021-10-31]
注释主要由正在检查其他代码的代码使用。 它们通常用于在运行时修改(即装饰或包装)现有类以更改其行为。 JUnit和Hibernate等框架使用注释来最大限度地减少编写自己使用框架所需的代码量。 Oracle在其网站上对Java的概念及其含义有很好的解释 。 Annotations are primarily used by code that is inspecting other code. They are often used for modifying (i.e. decorating or wra ...