JavaDoc注释

Java最常见的两种注释方法

  单行注释

    // 注释内容

  多行注释

  /*

  *  注释内容

  */

在Java中,还有另一种注释,称为JavaDoc注释

  /**

  *Text类

  *@author    yzw

  *@version  1.0 2017/08/14

  */

  语法规则

  1.JavaDoc注释以 /**  开头 */  结束。

  2.每个注释包含一些描述性的文本以及若干个JavaDoc标签

  3.JavaDoc标签一般已“@”为前缀,

  常见的JavaDoc标签及含义

标签 说明 JDK 1.1 doclet 标准doclet 标签类型
@author 作者 作者标识 包、 类、接口
@version 版本号 版本号 包、 类、接口
@param 参数名 描述 方法的入参名及描述信息,如入参有特别要求,可在此注释。 构造函数、 方法
@return 描述 对函数返回值的注释 方法
@deprecated 过期文本 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 包、类、接口、值域、构造函数、 方法
@throws异常类名 构造函数或方法所会抛出的异常。   构造函数、 方法
@exception 异常类名 同@throws。 构造函数、 方法
@see 引用 查看相关内容,如类、方法、变量等。 包、类、接口、值域、构造函数、 方法
@since 描述文本 API在什么程序的什么版本后开发支持。 包、类、接口、值域、构造函数、 方法
{@link包.类#成员 标签} 链接到某个特定的成员对应的文档中。   包、类、接口、值域、构造函数、 方法
{@value} 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。   √(JDK1.4) 静态值域

  

  

时间: 2024-11-10 15:42:33

JavaDoc注释的相关文章

Jindent——让intellij idea 像eclipse一样生成模版化的javadoc注释

插件地址 http://plugins.jetbrains.com/plugin/2170?pr=idea 安装方法参考 http://www.cnblogs.com/nova-/p/3535636.html 安装完成后 File>Settings>Jindent-Source Code Formatter 这里是编辑格式的区域 可以编辑和定义自己的变量 应用一下 格式化后 后记 这个插件不仅仅是进行javadoc注释,还可以进行各种文件的格式化.出现一些小问题就是不知道为什么有些注释的地方本

房上的猫:类的无参方法及JavaDoc注释

一.类的无参方法 1.概述:  (1)类是由一组具有相同属性和共同行为的实体抽象而来的  (2)对象执行的操作是通过编写类的方法实现的  (3)类的每一个方法都实现了一个功能 2.定义类的方法  编写方法:   (1)定义方法名和返回值类型   (2)在{}中编写方法的主体部分   注意:    (1)方法体放在一对大括号中(方法体就是一段程序代码,完成一定的工作)    (2)方法名主要在调用这个方法时使用(在java中一般采用骆驼式命名法)    (3)方法执行后可能会返回一个结果,该结果的

详细聊聊Javadoc注释规范

Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 @see 的使用 4.2 @author.@version 说明类 4.3 @param.@return 和 @exception 的使用 5. Javadoc命令 6. 注释范例 1.注释分类 对于Java注释共有三种分类: 1. // 注释单行 2. /* - */ 注释若干行 3. /* - /

javadoc注释标签语法

javadoc注释标签语法@author    对类的说明标明开发该类模块的作者@version   对类的说明 标明该类模块的版本@see      对类.属性.方法的说明 参考转向,也就是相关主题@param    对方法的说明 对方法中某参数的说明@return    对方法的说明 对方法返回值的说明@exception  对方法的说明 对方法可能抛出的异常进行说明

javadoc注释规范

javadoc做注释 一. Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /** * ......... * ......... */ javadoc -d 文档存放目录 -author -version 源文件名.java 这条命令编译一个名为 “源文件名.java”的 java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 index.html

javadoc 和 javadoc注释规范

javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档. javadoc命令是用来生成自己API文档的,使用方式:在dos中在目标文件所在目录输入javadoc +文件名.java. 标签 说明 JDK 1.1 doclet 标准doclet 标签类型 @author 作者 作者标识 √ √ 包. 类.接口 @version 版本号 版本号 √ √ 包. 类.接口 @param 参数名 描述 方法的入参名及描述信息,如入参有特别要求

javaDoc 注释规范

Javadoc虽然是Sun公司为Java文档自动生成设计的,可以从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档.但是Javadoc的注释也符合C的注释格式,而且doxyen也支持该种风格的注释. 官方文档:http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html 维基百科:https://en.wikipedia.org/wiki/Javadoc Javadoc 的注释结构和 C

Eclipse中给jar包导入JavaDoc注释文档的方法

第一步:将jar加入到Referenced Libraries 右键点击jar --> 选择 Build Path --> Add to Build Path 第二步,设置jar的java doc 右键点击Referenced Libraries下的jar --> 选择 Build Path --> Configure Build Path 选择jar的Javadoc location,点击Edit 以下是加载的两种方法,根据情况自己选择 选择Workspace File,点击Br

二、Javadoc注释

点击菜单栏上的Window -->Preferences-->Java-->Code Style -->Code Templates,对右侧Comments选项中具体的注释信息进行编辑即可.可勾选上自动添加注释信息,在生成java文件时便会自动生成注释,当然也可以手动插入注释. java注释快捷键:Ctrl + Shift + C,Ctrl + Shift + /,Ctrl + /. 原文地址:https://www.cnblogs.com/huanlingjisi/p/12084