---

[BigDataJava：Java&特殊類.V16]                                                                                 [BigDataJava.面向物件] [|章節五|特殊類|Documented的使用|]

---

---

一、Documented的使用

### --- 元註解@Documented

~~~     ——>        使用javadoc工具可以從程式原始碼中抽取類、方法、
~~~     ——>        成員等註釋形成一個和原始碼配套的API幫助文件，而該工具抽取時預設不包括註解內容。
~~~     ——>        @Documented用於指定被該註解將被javadoc工具提取成文件。
~~~     ——>        定義為@Documented的註解必須設定Retention值為RUNTIME。
 

二、程式設計程式碼

package com.yanqi.task10;

import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

//@Retention(RetentionPolicy.SOURCE)     // 表示下面的註解在原始碼中有效
//@Retention(RetentionPolicy.CLASS)      // 表示下面的註解在位元組碼檔案中有效，預設方式
@Retention(RetentionPolicy.RUNTIME)      // 表示下面的註解在執行時有效
@Documented                              // 表示下面的註解資訊可以被javadoc工具提取到API文件中，很少使用
// 若一個註解中沒有任何的成員，則這樣的註解叫做標記註解/標識註解
@interface MyAnnotation {
    //public Direction value(); // 宣告一個String型別的成員變數，名字為value   型別有要求
    public String value() default "123"; // 宣告一個String型別的成員變數，名字為value
    public String value2();
}
 

三、程式設計程式碼

package com.yanqi.task10;

// 表示將標籤MyAnnotation貼在Person類的程式碼中，使用註解時採用 成員引數名 = 成員引數值, ...
//@MyAnnotation(value = "hello", value2 = "world")
@MyAnnotation(value2 = "world")
public class Person {
    private String name;
    private int age;
    }

---

===============================END===============================

---

Walter Savage Landor:strove with none,for none was worth my strife.Nature I loved and, next to Nature, Art:I warm'd both hands before the fire of life.It sinks, and I am ready to depart                                                                                                                                                    ——W.S.Landor

---

來自為知筆記(Wiz)