当前位置: 首页 > news >正文

@Documented注解的作用

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

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

在这里插入图片描述

使用示例如下:

@Documented
public @interface DocumentedMy {
    String value() default "这是一个自定义类";
}
@DocumentedMy
public class MyTest1 {
    public String getStr() {
        return "123";
    }
}

生成javadoc文档有两种方式,一种是直接基于javadoc命令,一种是ide提供的!当然实际在开发当中我们很少会使用这个文档!除非我们要开源某个框架什么的才会用到!

通过ider生成javadoc文档:

1.点击项目当中的任意包

2.点击生成JavaDoc

3.指定生成位置

4.点击index.html

5.查看我们使用自定义注解的类,会发现他文档上面会展示这个自定义注解!

假如把自定义注解当中的@Documented去掉,然后使用该自定义注解的类,生成的文档就会不显示该注解!

@Deprecated:被标注过的方法,调用就会出现横线,表示不建议再继续使用,但是还能用!

在这里插入图片描述

/**
 * 测试Deprecated注解
 * @author Administrator
 */
public class DeprecatedDemoTest {
    public static void main(String[]args) {
        // 使用DeprecatedClass里声明被过时的方法
        DeprecatedClass.DeprecatedMethod();
    }
}

class DeprecatedClass {
    @Deprecated
    public static void DeprecatedMethod() {
    }
}

相关文章:

  • 9、微件篇——地图微件通用开发流程(适用于全部微件)
  • 【微搭低代码】美业小程序官方模板练习-绘制原型
  • 【数学建模】多元线性回归(PythonMatlab代码实现)
  • 软件能力成熟度模型CMM
  • 你们公司要求你写过如软著和专利吗?
  • 互联网网上赚钱最基本的方法与思维是什么?
  • SpringMvc+Spring+MyBatis+Maven+Ajax+Json注解开发 利用Maven的依赖导入不使用架包模式 (实操十二)
  • [Go WebSocket] 多房间的聊天室(三)自动清理无人房间
  • linux进程管理-进程
  • 【图像透视】基于matlab图像逆透视映射【含Matlab源码 2139期】
  • 【Java】逻辑控制
  • Qt下生成pdb文件,并在exe崩溃时生成dmp文件,且由dmp查询崩溃原因
  • 蜂鸣器、风扇、震动马达
  • 【VRP问题】基于帝国企鹅优化算法求解冷链配送物流车辆调度优化研究
  • 3) 时频分析与傅立叶变换
  • [笔记] php常见简单功能及函数
  • [译]Python中的类属性与实例属性的区别
  • 《用数据讲故事》作者Cole N. Knaflic:消除一切无效的图表
  • 【402天】跃迁之路——程序员高效学习方法论探索系列(实验阶段159-2018.03.14)...
  • 【RocksDB】TransactionDB源码分析
  • 【刷算法】求1+2+3+...+n
  • 2017-09-12 前端日报
  • 230. Kth Smallest Element in a BST
  • java 多线程基础, 我觉得还是有必要看看的
  • JAVA并发编程--1.基础概念
  • Making An Indicator With Pure CSS
  • Travix是如何部署应用程序到Kubernetes上的
  • vue--为什么data属性必须是一个函数
  • vue学习系列(二)vue-cli
  • - 概述 - 《设计模式(极简c++版)》
  • 学习HTTP相关知识笔记
  • 一文看透浏览器架构
  • RDS-Mysql 物理备份恢复到本地数据库上
  • 回归生活:清理微信公众号
  • ​人工智能之父图灵诞辰纪念日,一起来看最受读者欢迎的AI技术好书
  • # 飞书APP集成平台-数字化落地
  • $var=htmlencode(“‘);alert(‘2“); 的个人理解
  • (1) caustics\
  • (175)FPGA门控时钟技术
  • (6)添加vue-cookie
  • (C语言)字符分类函数
  • (Matlab)基于蝙蝠算法实现电力系统经济调度
  • (TipsTricks)用客户端模板精简JavaScript代码
  • (附源码)spring boot校园拼车微信小程序 毕业设计 091617
  • (四)TensorRT | 基于 GPU 端的 Python 推理
  • (四)汇编语言——简单程序
  • (未解决)macOS matplotlib 中文是方框
  • (转)EXC_BREAKPOINT僵尸错误
  • (转)Linux NTP配置详解 (Network Time Protocol)
  • (转)大道至简,职场上做人做事做管理
  • ******之网络***——物理***
  • *_zh_CN.properties 国际化资源文件 struts 防乱码等
  • .NET/C# 将一个命令行参数字符串转换为命令行参数数组 args
  • .net流程开发平台的一些难点(1)
  • /var/log/cvslog 太大