Gibt es eine Möglichkeit, das Javadoc-Tool zum Dokumentieren von Anmerkungen zu verwenden?

Question

In meinem Projekt verwenden wir eine Reihe von Anmerkungen, die in der javadoc-API-Dokumentation sehr nützlich sein könnten.

Kennt jemand eine einfache Möglichkeit, Anmerkungen in generierte Javadocs einzuschließen? Ich möchte kein eigenes Javadoc-Plugin schreiben. Gibt es da draußen Lösungen?

Answer 1

Siehe java.lang.annotation.Documented

Zeigt an, dass Anmerkungen mit einem Typ sind von javadoc und ähnlichen Werkzeugen standardmäßig dokumentiert werden. Dieser Typ sollte verwendet werden, um die Deklarationen von Typen zu kommentieren, deren Anmerkungen die Verwendung von annotierten Elementen durch ihre Clients beeinflussen. Wenn eine Typdeklaration mit Dokumentiert versehen ist, werden ihre Anmerkungen Teil der öffentlichen API der mit Anmerkungen versehenen Elemente.

Beispiel:

import java.lang.annotation.Documented; 

@Documented 
public @interface MyAnnotation { 
}