詳解Java?@Documented注解的作用

更新時間：2022年09月22日 09:40:22 作者：怪?咖@

@Documented和@Deprecated注解長得有點(diǎn)像，@Deprecated是用來標(biāo)注某個類或者方法不建議再繼續(xù)使用，@Documented只能用在注解上，本文將通過示例詳細(xì)說說@Documented注解的作用，需要的可以參考一下

@Documented和@Deprecated注解長得有點(diǎn)像，@Deprecated是用來標(biāo)注某個類或者方法不建議再繼續(xù)使用，@Documented只能用在注解上，如果一個注解@B，被@Documented標(biāo)注，那么被@B修飾的類，生成文檔時，會顯示@B。如果@B沒有被@Documented標(biāo)注，最終生成的文檔中就不會顯示@B。這里的生成文檔指的JavaDoc文檔！

@Deprecated注解基本上所有框架自定義的注解都會添加，所謂javadoc其實(shí)就是JDK給我們提供的一個生成文檔的工具！

使用示例如下：

@Documented
public @interface DocumentedMy {
    String value() default "這是一個自定義類";
}
@DocumentedMy
public class MyTest1 {
    public String getStr() {
        return "123";
    }
}

生成javadoc文檔有兩種方式，一種是直接基于javadoc命令，一種是ide提供的！當(dāng)然實(shí)際在開發(fā)當(dāng)中我們很少會使用這個文檔！除非我們要開源某個框架什么的才會用到！

通過ider生成javadoc文檔：

1.點(diǎn)擊項目當(dāng)中的任意包

2.點(diǎn)擊生成JavaDoc

3.指定生成位置

4.點(diǎn)擊index.html

5.查看我們使用自定義注解的類，會發(fā)現(xiàn)他文檔上面會展示這個自定義注解！

假如把自定義注解當(dāng)中的@Documented去掉，然后使用該自定義注解的類，生成的文檔就會不顯示該注解！

@Deprecated：被標(biāo)注過的方法，調(diào)用就會出現(xiàn)橫線，表示不建議再繼續(xù)使用，但是還能用！

/**
 * 測試Deprecated注解
 * @author Administrator
 */
public class DeprecatedDemoTest {
    public static void main(String[]args) {
        // 使用DeprecatedClass里聲明被過時的方法
        DeprecatedClass.DeprecatedMethod();
    }
}

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

到此這篇關(guān)于詳解Java @Documented注解的作用的文章就介紹到這了,更多相關(guān)Java @Documented內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章:

相關(guān)文章

Spring MVC 自定義數(shù)據(jù)轉(zhuǎn)換器的思路案例詳解
本文通過兩個案例來介紹下Spring MVC 自定義數(shù)據(jù)轉(zhuǎn)換器的相關(guān)知識，每種方法通過實(shí)例圖文相結(jié)合給大家介紹的非常詳細(xì),需要的朋友可以參考下
2021-09-09
在java中由類名和方法名字符串實(shí)現(xiàn)其調(diào)用方式
這篇文章主要介紹了在java中由類名和方法名字符串實(shí)現(xiàn)其調(diào)用方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
2020-09-09
Java用itextpdf導(dǎo)出PDF方法(通俗易懂)
因為項目需要導(dǎo)出PDF文件,所以去找了一下能夠生成PDF的java工具,這篇文章主要給大家介紹了關(guān)于Java用itextpdf導(dǎo)出PDF的相關(guān)資料,文中介紹的方法通俗易懂,需要的朋友可以參考下
2023-07-07
JAVA 枚舉單例模式及源碼分析的實(shí)例詳解
這篇文章主要介紹了 JAVA 枚舉單例模式及源碼分析的實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下
2017-08-08
解決mybatis #{}無法自動添加引號的錯誤
這篇文章主要介紹了解決mybatis #{}無法自動添加引號的錯誤，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2022-01-01
RestTemplate發(fā)送請求時Cookie的影響及注意事項說明
這篇文章主要介紹了RestTemplate發(fā)送請求時Cookie的影響及注意事項說明，具有很好的參考價值，希望對大家有所幫助。
2023-07-07
如何解決springcloud feign 首次調(diào)用100%失敗的問題
這篇文章主要介紹了如何解決springcloud feign 首次調(diào)用100%失敗的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教
2021-06-06
利用keytools為tomcat 7配置ssl雙向認(rèn)證的方法
雙向認(rèn)證和單向認(rèn)證原理基本差不多，只是除了客戶端需要認(rèn)證服務(wù)端以外，增加了服務(wù)端對客戶端的認(rèn)證，下面這篇文章主要介紹了利用keytools為tomcat 7配置ssl雙向認(rèn)證的方法，需要的朋友可以借鑒，下面來一起看看吧。
2017-02-02
Java實(shí)現(xiàn)調(diào)用第三方相關(guān)接口
最近在做一個項目,需要調(diào)用第三方接口,本文主要介紹了Java實(shí)現(xiàn)調(diào)用第三方相關(guān)接口,具有一定的參考價值,感興趣的可以了解一下
2023-09-09
Java基于鏈表實(shí)現(xiàn)棧的方法詳解
這篇文章主要介紹了Java基于鏈表實(shí)現(xiàn)棧的方法,結(jié)合實(shí)例形式詳細(xì)分析了Java基于鏈表實(shí)現(xiàn)棧的原理、操作步驟與相關(guān)注意事項,需要的朋友可以參考下
2020-03-03