詳解Java?@Documented注解的作用
@Documented
和@Deprecated
注解長(zhǎng)得有點(diǎn)像,@Deprecated
是用來(lái)標(biāo)注某個(gè)類(lèi)或者方法不建議再繼續(xù)使用,@Documented
只能用在注解上,如果一個(gè)注解@B,被@Documented
標(biāo)注,那么被@B修飾的類(lèi),生成文檔時(shí),會(huì)顯示@B。如果@B沒(méi)有被@Documented
標(biāo)注,最終生成的文檔中就不會(huì)顯示@B。這里的生成文檔指的JavaDoc文檔!
@Deprecated
注解基本上所有框架自定義的注解都會(huì)添加,所謂javadoc其實(shí)就是JDK給我們提供的一個(gè)生成文檔的工具!
使用示例如下:
@Documented public @interface DocumentedMy { String value() default "這是一個(gè)自定義類(lèi)"; } @DocumentedMy public class MyTest1 { public String getStr() { return "123"; } }
生成javadoc文檔有兩種方式,一種是直接基于javadoc命令,一種是ide提供的!當(dāng)然實(shí)際在開(kāi)發(fā)當(dāng)中我們很少會(huì)使用這個(gè)文檔!除非我們要開(kāi)源某個(gè)框架什么的才會(huì)用到!
通過(guò)ider生成javadoc文檔:
1.點(diǎn)擊項(xiàng)目當(dāng)中的任意包
2.點(diǎn)擊生成JavaDoc
3.指定生成位置
4.點(diǎn)擊index.html
5.查看我們使用自定義注解的類(lèi),會(huì)發(fā)現(xiàn)他文檔上面會(huì)展示這個(gè)自定義注解!
假如把自定義注解當(dāng)中的@Documented去掉,然后使用該自定義注解的類(lèi),生成的文檔就會(huì)不顯示該注解!
@Deprecated:被標(biāo)注過(guò)的方法,調(diào)用就會(huì)出現(xiàn)橫線(xiàn),表示不建議再繼續(xù)使用,但是還能用!
/** * 測(cè)試Deprecated注解 * @author Administrator */ public class DeprecatedDemoTest { public static void main(String[]args) { // 使用DeprecatedClass里聲明被過(guò)時(shí)的方法 DeprecatedClass.DeprecatedMethod(); } } class DeprecatedClass { @Deprecated public static void DeprecatedMethod() { } }
到此這篇關(guān)于詳解Java @Documented注解的作用的文章就介紹到這了,更多相關(guān)Java @Documented內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
spring cloud Feign使用@RequestLine遇到的坑
這篇文章主要介紹了spring cloud Feign使用@RequestLine遇到的坑,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-06-06解決SpringBoot2多線(xiàn)程無(wú)法注入的問(wèn)題
這篇文章主要介紹了解決SpringBoot2多線(xiàn)程無(wú)法注入的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-08-08深入Spring Boot之ClassLoader的繼承關(guān)系和影響
這篇文章主要介紹了深入Spring Boot之ClassLoader的繼承關(guān)系和影響,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-06-06mybatis foreach遍歷LIST讀到數(shù)據(jù)為null的問(wèn)題
這篇文章主要介紹了mybatis foreach遍歷LIST讀到數(shù)據(jù)為null的問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。2022-02-02Java基本數(shù)據(jù)類(lèi)型之間的相互轉(zhuǎn)換詳解
這篇文章主要講解Java中基本數(shù)據(jù)類(lèi)型的轉(zhuǎn)換,數(shù)據(jù)之間相互轉(zhuǎn)換是經(jīng)常會(huì)用到的基礎(chǔ)操作,文中講的很清晰,希望能給大家做一個(gè)參考。2022-05-05Java中LambdaQueryWrapper的常用方法詳解
這篇文章主要給大家介紹了關(guān)于Java中LambdaQueryWrapper常用方法的相關(guān)資料,lambdaquerywrapper是一個(gè)Java庫(kù),用于構(gòu)建類(lèi)型安全的Lambda表達(dá)式查詢(xún),需要的朋友可以參考下2023-11-11java中對(duì)象為null時(shí)的打印輸出方式
這篇文章主要介紹了java中對(duì)象為null時(shí)的打印輸出方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-09-09Spingboot?JPA?CriteriaBuilder?如何獲取指定字段
這篇文章?主要介紹了Spingboot?JPA?CriteriaBuilder?如何獲取指定字段,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12Java中反射的"暴破"機(jī)制(SetAccessible方法)詳解
這篇文章主要為大家詳細(xì)介紹了Java中反射的"暴破"機(jī)制,以及如何利用這一機(jī)制實(shí)現(xiàn)訪(fǎng)問(wèn)非公有屬性,方法,和構(gòu)造器,文中示例代碼講解詳細(xì),感興趣的可以了解一下2022-08-08java實(shí)現(xiàn)批量下載 多文件打包成zip格式下載
這篇文章主要為大家詳細(xì)介紹了java實(shí)現(xiàn)批量下載、將多文件打包成zip格式下載,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2019-07-07