@Documented

@Documented ist eine Annotation, welche von Dokumentationswerkzeugen, wie z.B. JavaDoc, ausgewertet wird. Solche Dokumentationswerkzeug sorgen dafür, dass diese Annotation, so wie die anderer Modifizierer (z.B. protected, static) in die Dokumentation mit eingehen. Nehmen wir als Beispiel die @GroupTODO Annotation. Wird diese mit @Documented versehen.

1  @Documented
2  public @interface GroupTODO {
3    public enum Severity {CRITICAL, IMPORTANT, TRIVIAL};
4
5    Severity severity() default Severity.IMPORTANT;
6    String item();
7    String assignedTo();
8    String dateAssigned();
9  }

So stehen die Informationen, die dem annotierten Element über @GroupTODO gegeben wurden, in der Dokumentation. Annotationen, die durch die Verwendung von Inherited geerbt wurden, stehen nicht in der Dokumentation.

Abbildung 1:

JavaDoc

[weiter][zurück][Seiten Anfang][hoch]