详解Java @Documented注解的作用
更新时间：2022年09月22日 09:40:22 作者：怪 咖@
@Documented和@Deprecated注解长得有点像，@Deprecated是用来标注某个类或者方法不建议再继续使用，@Documented只能用在注解上，本文将通过示例详细说说@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() {
}
}
到此这篇关于详解Java @Documented注解的作用的文章就介绍到这了,更多相关Java @Documented内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
POP3/IMAP协议定义了邮件客户端软件和POP3邮件服务器的通信规则，这篇文章我们就来手工体验SMTP和POP3协议的奥秘，感兴趣的小伙伴们可以参考一下2017-10-10
这篇文章主要为大家详细介绍了Java实现图片拼接的相关代码，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2018-08-08
这篇文章主要介绍了基于SpringBoot实现自动装配返回属性,这里涉及到的技术知识点有注解解析器，为什么用ResponseBodyAdvice这里解析?不在Filter,Interceptors，本文结合示例代码给大家介绍的非常详细，需要的朋友参考下吧2022-03-03
Spring Boot 中的 @PutMapping 注解原理及使用小结
在本文中,我们介绍了 Spring Boot 中的 @PutMapping 注解,它可以将 HTTP PUT 请求映射到指定的处理方法上,我们还介绍了 @PutMapping 注解的原理以及如何在 Spring Boot 中使用它,感兴趣的朋友跟随小编一起看看吧2023-12-12
本文主要介绍了MyBatis-Plus 分页查询的实现示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-03-03
在现代应用程序中,异步编程已经成为了必备的技能,异步编程使得应用程序可以同时处理多个请求,从而提高了应用程序的吞吐量和响应速度,在SpringBoot 中,我们可以使用 @Async 注解来实现异步编程,本文将介绍 @Async 注解的使用方法和注意事项2023-09-09
Java 中HttpURLConnection附件上传的实例详解
这篇文章主要介绍了Java 中HttpURLConnection附件上传的实例详解的相关资料,希望通过本文大家能掌握这样的知识内容，需要的朋友可以参考下2017-09-09
这篇文章主要介绍了Mybatis如何通过出入Map参数作为条件进行查询，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教2022-06-06
这篇文章主要介绍了在RedHat系统上安装Java与Tomcat的步骤,同样适用于CentOS等RedHat系的Linux系统,需要的朋友可以参考下2015-11-11
Java如何将处理完异常之后的程序能够从抛出异常的地点向下执行?
今天小编就为大家分享一篇关于Java如何将处理完异常之后的程序能够从抛出异常的地点向下执行?，小编觉得内容挺不错的，现在分享给大家，具有很好的参考价值，需要的朋友一起跟随小编来看看吧2019-04-04
最新评论