詳解Java?@Documented注解的作用
@Documented
和@Deprecated
注解長得有點像,@Deprecated
是用來標注某個類或者方法不建議再繼續(xù)使用,@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提供的!當然實際在開發(fā)當中我們很少會使用這個文檔!除非我們要開源某個框架什么的才會用到!
通過ider生成javadoc文檔:
1.點擊項目當中的任意包
2.點擊生成JavaDoc
3.指定生成位置
4.點擊index.html
5.查看我們使用自定義注解的類,會發(fā)現(xiàn)他文檔上面會展示這個自定義注解!
假如把自定義注解當中的@Documented去掉,然后使用該自定義注解的類,生成的文檔就會不顯示該注解!
@Deprecated:被標注過的方法,調(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 cloud Feign使用@RequestLine遇到的坑
這篇文章主要介紹了spring cloud Feign使用@RequestLine遇到的坑,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-06-06深入Spring Boot之ClassLoader的繼承關(guān)系和影響
這篇文章主要介紹了深入Spring Boot之ClassLoader的繼承關(guān)系和影響,小編覺得挺不錯的,現(xiàn)在分享給大家,也給大家做個參考。一起跟隨小編過來看看吧2018-06-06mybatis foreach遍歷LIST讀到數(shù)據(jù)為null的問題
這篇文章主要介紹了mybatis foreach遍歷LIST讀到數(shù)據(jù)為null的問題,具有很好的參考價值,希望對大家有所幫助。2022-02-02Java基本數(shù)據(jù)類型之間的相互轉(zhuǎn)換詳解
這篇文章主要講解Java中基本數(shù)據(jù)類型的轉(zhuǎn)換,數(shù)據(jù)之間相互轉(zhuǎn)換是經(jīng)常會用到的基礎(chǔ)操作,文中講的很清晰,希望能給大家做一個參考。2022-05-05Java中LambdaQueryWrapper的常用方法詳解
這篇文章主要給大家介紹了關(guān)于Java中LambdaQueryWrapper常用方法的相關(guān)資料,lambdaquerywrapper是一個Java庫,用于構(gòu)建類型安全的Lambda表達式查詢,需要的朋友可以參考下2023-11-11Spingboot?JPA?CriteriaBuilder?如何獲取指定字段
這篇文章?主要介紹了Spingboot?JPA?CriteriaBuilder?如何獲取指定字段,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2021-12-12Java中反射的"暴破"機制(SetAccessible方法)詳解
這篇文章主要為大家詳細介紹了Java中反射的"暴破"機制,以及如何利用這一機制實現(xiàn)訪問非公有屬性,方法,和構(gòu)造器,文中示例代碼講解詳細,感興趣的可以了解一下2022-08-08java實現(xiàn)批量下載 多文件打包成zip格式下載
這篇文章主要為大家詳細介紹了java實現(xiàn)批量下載、將多文件打包成zip格式下載,具有一定的參考價值,感興趣的小伙伴們可以參考一下2019-07-07