@Documented注解的作用

原创 已于 2023-04-23 00:39:08 修改 · 1.1w 阅读 · 17 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #spring #开发语言

于 2022-09-21 22:00:42 首次发布
本文介绍了Java中的两种注解：@Documented用于自定义注解以在文档中显示，而@Deprecated则标记不建议使用的类或方法。文章通过示例解释了这两种注解的具体使用方法。

@Documented和@Deprecated注解长得有点像，@Deprecated是用来标注某个类或者方法不建议再继续使用，@Documented只能用在注解上，如果一个注解@B，被@Documented标注，那么被@B修饰的类，生成文档时，会显示@B。如果@B没有被@Documented标注，最终生成的文档中就不会显示@B。这里的生成文档指的JavaDoc文档！

@Deprecated注解基本上所有框架自定义的注解都会添加，所谓javadoc其实就是JDK给我们提供的一个生成文档的工具！

在这里插入图片描述

使用示例如下：

@Documented
public @interface DocumentedMy {
   
   
    String value(
最低0.47元/天 解锁文章
如何详解Java中的@Documented注解的作用和用法
专注于深入研究多种编程语言，以实战为导向，逐步拓展开发技能，提升工程化编码和思维能力，展现无敌技术实力。
07-26 2406
通过本文，我们详细介绍了Java中的@Documented注解的作用和用法。@Documented注解允许被它修饰的注解的信息出现在生成的API文档中，这对于标记重要元数据信息的注解非常有用。我们通过一个示例代码演示了@Documented注解的实际效果，包括如何在API文档中展示自定义注解的信息。
@Documented:
henry的专栏
03-26 1770
@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。
@Documented 的作用
howeres的博客
03-07 9438
1. @Documented 的含义 @Document 是 java 在生成文档，是否显示注解的开关 2. 加和不加有什么区别？ 使用命令 // 生成 java doc 的命令： javadoc -d doc demo.java` // -d <directory> 输出文件的目标目录 a. 加上的效果 b. 不加的效果 可以看到在 public class TerminalController 上面多了一个我们写的注解。这就是 @Documented 的用处。 ...
@Documented注解作用
weixin_37634084的博客
12-17 618
Documented注解会影响javadoc生成的类上面是否保留注解。
@Documented 注解的作用
最新发布
06-26
首先，用户的问题是：“我想理解Java中@Documented注解的作用请问Java@Documented注解的作用和使用场景”。这直接询问@Documented注解的作用和使用场景。从系统级指令中，我知道：-所有行内数学表达式必须用$...$，...
Documented 注解
weixin_34395205的博客
05-17 2077
2019独角兽企业重金招聘Python工程师标准>>> ...
java @Target@Retention @Documented 注解的含义
qq_42718938的博客
08-18 296
spring 注解@Target@Retention @Documented 当我们看想看一个spring 注解点击进去看的时候就会发现,注解类中大多都会有标题中的这三个注解,这三个注解什么意思呢?,在工作摸鱼的时候,我就简单了解一下: @Target 翻译后就是,目标的意思,该注解的意思是注解使用的作用目标,其中{ElementType枚举类包含了,{TYPE(类型)},FIELD(外),METHOD(方法),PARAMETER(参数),PACKAGE(包)}等. @Retention 是指被他注解的注
@Documented
qq_41177135的博客
07-29 3188
@Documented
Java注解基本原理
Wnliam的博客
11-07 305
Java注解基本原理 注解目前非常的流行，很多主流框架都支持注解，而且自己编写代码的时候也会尽量的去用注解，一时方便，而是代码更加简洁。 注解的语法比较简单，除了@符号的使用之外，它基本与Java固有语法一致。Java SE5内置了三种标准注解： @Override，表示当前的方法定义将覆盖超类中的方法。 @Deprecated，使用了注解为它的元素编译器将发出警告，因为注解@Depre...
Documented元注解
weixin_43808717的博客
04-09 836
Documented：说明该注解将会被包含在JavaDoc文档中，我们常见的JDK帮助文档参考手册就是JavaDoc。 编写一个普通的注解，并且保证(RetentionPolicy.RUNTIME) package javadoc; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interfa
Spring Boot中的@Document注解：原理与使用
程序员徐师兄的博客
06-30 3480
使用Spring Data MongoDB框架，可以很容易地定义数据访问层。在该数据访问层中，使用了Spring Data MongoDB框架提供的MongoRepository接口，该接口提供了许多常用的数据访问方法，例如findById、findAll、save等。此外，还可以自定义数据访问方法，例如findByName。本文介绍了Spring Boot中的@Document注解的原理与使用。
@Documented注释 javadoc
涟涟的博客
08-19 448
# 代码： //代码1： import java.lang.annotation.Documented; @Documented public @interface Override { String info(); } //代码2： public class Student { @Override(info="重写了toString()") public String toS...
JAVA注解学习-@Documented注解
热门推荐
madman
12-22 4万+
这个注解只是用来标注生成javadoc的时候是否会被记录。 用法 在自定义注解的时候可以使用@Documented来进行标注，如果使用@Documented标注了，在生成javadoc的时候就会把@Documented注解给显示出来。 带@Documented生成的javadoc 不带@Documented生成的javadoc 这两个图的唯一差距就是类的说明是否有这个@API注解。 总结...
JAVA注解笔记之@Document
qq_40788718的博客
10-30 5889
@Document @Documented 表明这个注解应该被 javadoc工具记录，正常情况下javadoc中不包含注解的，@Documented属于标志注解。 @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Documented { }...
@Target,@Rentention,@Inherited,@Document等注解的作用
weixin_45802793的博客
09-27 502
由来 今天我在学习小组的框架，正好学习到了注解,那我就进而想知道每个注解都是啥意思，尤其是每个注解里面的前半部分都有几个固定注解，接下来咱们一起研究一下吧 @Target:注解作用的目标 @Target(ElementType.TYPE) ——接口，类，枚举，注解 @Target(ElementType.FIELD)——字段，枚举常量 @Target(ElementType.METHOD)——方法 @Target(ElementType.PARAMETER)——方法参数 @Target(Elemen
Spring常用注解
月落星沉
08-16 490
1.第一章 day01 Java概述 环境搭建 1.java的好处 1：跨平台 （平台：指的是操作系统） 常见的操作系统：Windows Unix Linux Solaris ->Sun 跨平台：指的是我们开发出来的应用程序 是不受操作系统的显示 底层的功臣：JVM = java虚拟机 = 1 + 2 + 3 =秘书 = 类加载器 = ClassLoader （加
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

怪 咖@

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值