Анотації в Java. @Documented

За замовчуванням інформація про анотації не додається в документацію JavaDoc. Анотація @Documented використовується при оголошенні іншої анотації щоб вказати, що дана анотація буде вказана в згенерованій документації JavaDoc.

Припустимо, що є анотація @Mammal, оголошена з анотацією @Documented:

package com.seostella.annotation.def;

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

@Target(ElementType.TYPE)
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Mammal {
	String sound();

	int color();
}

У наступному прикладі до класу Giraffe додасться повна інформація про анотацію @Mammal в JavaDoc:

package com.seostella.annotation.domain;

import com.seostella.annotation.def.HasHorn;
import com.seostella.annotation.def.Mammal;

@Mammal(color = 0xFFA844, sound = "uuuu")
public class Giraffe {
	
	@HasHorn
	public void drawHead() {
	}
	
}

У наступній статті буде розглянута остання з чотирьох стандартних анотацій, які можуть бути використані з іншими анотаціями, @Inherited.