@Documented注解標記的元素，Javadoc工具會將此注解標記元素的注解信息包含在javadoc中。默認，注解信息不會包含在Javadoc中。示例如下：
聲明Book注解，並使用@Document標記：
package org.springmorning.demo.javabase.annotation.meta; import java.lang.annotation.Documented; import java.lang.annotation.Inherited; /** * @author 春晨 * Copyright ©2019 春晨 https://www.cnblogs.com/springmorning/p/10261472.html */ @Documented @Inherited public @interface Book { //書名 String name(); //出版日期 String publishedDate(); //作者 String author(); }
使用@Book注解標記類DocumentAnnotation，Book標記元素內容如下：
package org.springmorning.demo.javabase.annotation.meta; /** * @author 春晨 * Copyright ©2019 春晨 https://www.cnblogs.com/springmorning/p/10261472.html */ @Book( name = "Spring in Action", author = "Craig Walls", publishedDate = "2008-10-1" ) public class DocumentAnnotation {}
打開cmd 輸入javadoc命令：
javadoc -d D:\doc org.springmorning.demo.javabase.annotation.meta -encoding utf-8 -charset utf-8
說明：
-d D:\doc 表示：doc文件輸入目錄為D盤的doc文件夾；
org.springmorning.demo.javabase.annotation.meta 表示此包中所有類需要生成java doc html文件；
-encoding utf-8 表示：java代碼采用的是utf-8字符編碼編寫的；
-charset utf-8 表示：java doc html文件為utf-8字符編碼。
運行結果：
javadoc 命令生成的java doc文檔：
瀏覽器打開index.html查看里面的內容，可以看到@Book注解的文檔說明：
點左側欄中的“DocumentAnnotation"，打開DocumentAnnotation類的文檔說明，可以看到@Book標記的注解內容顯示了出來：
如果@Book注解沒有被@Document標記，那么被@Book注解標記的DocumentAnnotation類的注解信息就不會包含在java doc html文檔中：如下圖
下節繼續
下節將給大家講解元注解@Inherited的使用