当前位置: 首页 > 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) 时频分析与傅立叶变换
  • __proto__ 和 prototype的关系
  • 【css3】浏览器内核及其兼容性
  • CSS中外联样式表代表的含义
  • JavaScript 奇技淫巧
  • Java深入 - 深入理解Java集合
  • js ES6 求数组的交集,并集,还有差集
  • Linux编程学习笔记 | Linux IO学习[1] - 文件IO
  • Yii源码解读-服务定位器(Service Locator)
  • 多线程 start 和 run 方法到底有什么区别?
  • 关于Flux,Vuex,Redux的思考
  • 基于Volley网络库实现加载多种网络图片(包括GIF动态图片、圆形图片、普通图片)...
  • 基于遗传算法的优化问题求解
  • 前端路由实现-history
  • 前端面试之闭包
  • 腾讯优测优分享 | Android碎片化问题小结——关于闪光灯的那些事儿
  • 写代码的正确姿势
  • 教程:使用iPhone相机和openCV来完成3D重建(第一部分) ...
  • ​Kaggle X光肺炎检测比赛第二名方案解析 | CVPR 2020 Workshop
  • ( 用例图)定义了系统的功能需求,它是从系统的外部看系统功能,并不描述系统内部对功能的具体实现
  • (MIT博士)林达华老师-概率模型与计算机视觉”
  • (TipsTricks)用客户端模板精简JavaScript代码
  • (ZT) 理解系统底层的概念是多么重要(by趋势科技邹飞)
  • (笔试题)合法字符串
  • (附源码)spring boot球鞋文化交流论坛 毕业设计 141436
  • (附源码)springboot青少年公共卫生教育平台 毕业设计 643214
  • (十一)c52学习之旅-动态数码管
  • (转载)Linux 多线程条件变量同步
  • **登录+JWT+异常处理+拦截器+ThreadLocal-开发思想与代码实现**
  • .gitignore文件—git忽略文件
  • .NET Core使用NPOI导出复杂,美观的Excel详解
  • .net on S60 ---- Net60 1.1发布 支持VS2008以及新的特性
  • .net 反编译_.net反编译的相关问题
  • .NET/ASP.NETMVC 深入剖析 Model元数据、HtmlHelper、自定义模板、模板的装饰者模式(二)...
  • .NET开发人员必知的八个网站
  • .NET设计模式(8):适配器模式(Adapter Pattern)
  • .NET与 java通用的3DES加密解密方法
  • .Net中wcf服务生成及调用
  • .pyc文件还原.py文件_Python什么情况下会生成pyc文件?
  • //解决validator验证插件多个name相同只验证第一的问题
  • @SentinelResource详解