JAVA注释 javadoc 标记含义

最新推荐文章于 2023-08-15 16:14:30 发布
最新推荐文章于 2023-08-15 16:14:30 发布
阅读量770 收藏 2
点赞数
分类专栏： 架构之师 文章标签： javadoc 注释 class
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/springlovejava/article/details/78759029
版权

javadoc 标记由@ 符号开始 其后跟的标记类型和专用注释引用组成

常用标记如下：

/**
 * @author 标明开发该类模块的作者
 * @version 标明该类模块的版本
 * @see 参考转向，也就是相关主题
 * @param 对方法中某参数的说明
 * @return 对方法返回值的说明
 * @exception 对方法可能抛出的异常进行说明
 * @return 返回值说明
 * @throws Exception 抛出的异常
 */


  

springlovejava
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
javadoc 标签
Whtai_的博客
08-27 1630
javadoc 标签 javadoc 工具软件识别以下标签： 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated description {@docRoot} 指明当前文档根目录的路径 Directory Path @exception 标志一个类抛出的异常 @exception exception-name explanation {@inheritDoc} 从直
Java-文档注释例子
最新发布
09-04
在Java编程语言中，文档注释（Javadoc）是一种特殊类型的注释，它用于生成关于代码的自动文档。本文将深入探讨Java文档注释的概念、语法以及如何使用它来提高代码的可读性和维护性。 一、Java文档注释的作用 1. ...
Java中Javadoc的{@link}与@see的简单区别
weixin_34024034的博客
12-03 651
{@link}与@see这两个Javadoc注解都可以直接链接类和方法。用法基本一致。 但是@see必须顶头写，而{@link可以任意地方}，如下所示：     参考： http://blog.csdn.net/qq_27093465/article/details/59121608（以上图片转自此篇文章）...
什么是javadoc？
qq_45346896的博客
11-12 1221
1.什么是javadoc？ Javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形式程序的开发文档了。 JBuilder提供了多项对Javadoc支持的功能，可以通过向导在工程窗格的树中创建Javadoc的节点，通过节点的菜单命名创建工...
Java注释有红线_VS2013中文注释下面总出现红线该怎么办?
weixin_36307377的博客
02-26 447
VS2013中文内容下面总出现红线该怎么办？输入的英文完全没问题，但是中文注释下面总是出现红色线条，英文注释却没有，该怎么解决呢？下面分享详细的解决办法，需VS2013中文内容下面总出现红线该怎么办？输入的英文完全没问题，但是中文注释下面总是出现红色线条，英文注释却没有，该怎么解决呢？下面分享详细的解决办法，需要的朋友可以参考下最近在VS2013中安装了visual assist X助手插件，但是...
Javadoc标签
weixin_49302930的博客
08-15 611
以上是一些常用的Javadoc标签，可以根据需要在文档注释中使用这些标签来提供更详细的信息和指导。另外，Javadoc还支持其他标签和自定义标签，可以根据具体需求进行使用。符号开头，用于描述类、方法、字段等的特性和用法。Javadoc标签是用于在文档注释中提供额外信息的特殊标记。
Java注释全解文档.zip
03-02
Java注释在编程世界中扮演着重要的角色，它们为代码提供了清晰的解释，增强了可读性和维护性。本文档集合了关于Java注释的全面解析，涵盖了Spring、Hibernate以及Struts2框架中的注解使用。以下是对每个标签及文件...
在idea中为注释标记作者日期操作
08-24
" IDEA中的注释标记作者日期操作" IDEA是一款功能强大且广泛使用的集成开发环境（Integrated Development Environment），它提供了许多实用的功能来提高开发效率和代码质量。在 IDEA 中，为注释标记作者日期操作是...
全面解析Java中的注解与注释
09-02
3. **Javadoc**：Java的特殊注释形式，以`/**`开始，`*/`结束，用于生成API文档。Javadoc可以捕获方法、类和接口的详细描述，并自动生成HTML文档。 **总结** 注解和注释在Java编程中都扮演着不可或缺的角色。注解...
javadoc标准注释文档
07-07
在Java编程中，Javadoc注释是一种特殊的多行注释，专门用于生成文档。它们以`/**`开头，以`*/`结尾，可以应用于类、接口、方法、构造器等。下面我们将深入探讨Javadoc注释的相关知识点： 1. **Javadoc注释格式**： ...
JavaDOC注释使用方法
09-19
Java 程序员都应该知道使用 JDK 开发，最好的帮助信息就来自 SUN 发布的 Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息，具有详细的类树信息、索引信息等，并提供了许多相关类之间的关系，如继承、实现接口、引用等。
Java文档注释-JavaDoc标签
qq_43085982的博客
04-26 2247
以@符号开始的标记称为单行标记(也称为块标记)，并且它们必须在自己的行中使用。以花括号开始的标记，例如{@code}，称为内联标记，它们必须在更大的描述中使用。在文档注释中，也可以使用其他标准的 HTML 标记。。但是，有些标记不应当使用，例如标题，因为它们会破坏由javadoc生成的HTML文件的外观。因为与文档化源代码有关，所以可以使用文档注释文档化类、接口、域变量、构造函数以及方法。对于所有情况，文档注释必须位于被文档化的条目之前。
java doc 标记,javadoc标记
weixin_29717341的博客
03-19 613
参考：1、@author该标记使用频率是所有文档标记中最高的，我想这是因为：做好事要留名使用超简单，就像在填表格(姓名：)一样自然来看看大牛怎么写的： (from Commons Lang 2.5 StringUtils)总结下来有三种写法：纯文本带邮箱链接带 HTTP 链接(个人建议用 HTTP 链接：打码时可以顺便推广一下自己的博客，哈哈)另外，在 JDK 代码中我们经常看到 @author...
java doc文档标记的说明
你总是想知道的博客
11-30 349
javadoc 概要描述 详细描述 文档标注 ：注释中@开头注解 称为Javadoc的文档标注 方法上的文档标注 @param <参数名> <参数描述> @return <返回值得描述> @throws <异常类型> <异常描述> 用于描述方法内部可能抛出的异常 @exception <异常类型> <异常描述> 用于描述方法签名对应的异常 @see 描述可以参考的类或者方法 @value 格式{@value } 用于
Java笔记 包 javadoc标记
qq_53252172的博客
05-23 220
调用s所指对象的setAge方法，通过堆区的对象方法区的setAge方法找到在方法区的共享代码段的setAge方法的地址，然后调用，会在栈中开辟一个setAge的方法工作空间，在该工作空间中开辟一个变量空间student_age存值18，然后把该值赋给堆区的该对象的属性空间的age属性;在主方法的栈空间开辟一个名为s类型为Student类型的空间（创建了一个变量存放对象的地址，4字节,还没有创建对象），在当前目录中找到Student.class来加载到类代码区。//左右类型必须一致！
Java文档注释+JavaDoc的使用详解
杨DaB的博客
07-26 474
Java文档注释+JavaDoc的使用详解 简介 文档注释负责描述类、接口、方法、构造器、成员属性。可以被JDK提供的工具 javadoc 所解析，自动生成一套以网页文件形式体现该程序说明文档的注释。 注意：文档注释必须写在类、接口、方法、构造器、成员字段前面，写在其他位置无效。 JavaDoc 官方说明 How to Write Doc Comments for the Javadoc Tool 写在类上面的JavaDoc 写在类上的文档标注一般分为三段： 第一段：概要描述，通常用一句或者一段话简要描
javadoc标记
xiaoqichuan的博客
08-28 100
  javadoc命令，如下例： javadoc -d PersonJavaDoc -version -author PersonJavaDoc.java -d：表示生成目录，目录名称为PersonJavaDoc -version：表示要求javadoc程序在说明文件中加入版本信息。 -author：表示要求javadoc程序在说明文件中加入作者信息。 ...
javadoc生成注释文档
君哥聊编程
11-26 4988
javadoc生成注释文档
Javadoc常见的标记和含义
weixin_30892763的博客
08-13 414
1.@param 方法参数的说明 2.@return 对 方法返回值的说明 3.@throws 方法抛出异常的描述 4.@version模块的版本号 5.see参数转向 6.@deprecated标记是否过时 转载于:https://www.cnblogs.com/loaderman/p/7354747.html...
Java注释规范与Javadoc使用指南
"Java注释的使用规范与Javadoc详解" 在Java编程中，注释是一种重要的辅助工具，它能够帮助开发者理解代码的功能和用途。本文主要探讨的是Java中的Javadoc，这是一种特殊的注释方式，可以自动生成文档，提供详细的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值