Gibt es eine Möglichkeit, "Javadoc -Typen" zu definieren - benutzerdefinierte Parameter für Mitglieder?

Question

Der Anwendungsfall, den ich mir vorstellen kann, ist Folgendes:

In einer typischen Anwendung gibt es in der Regel viele Mitglieder einer bestimmten Kategorie, z. B. eine Webanwendung, viele Konstanten -Attributschlüssel, Aktionsklassen, Dienste usw. für jede Kategorie, um die Konsistenz aufrechtzuerhalten. Es ist nützlich, sie konsequent zu dokumentieren.

Betrachten Sie die für Attributschlüssel verwendeten Konstanten:

/**
 * Request scope attribute key of the {@link com.acme.domain.User} object added by the {@link LoginAction}.
 */
public static final String USER_KEY = "com.acme.web.user";

Jeder Attributschlüssel sollte typischerweise seinen Umfang dokumentieren, den unter ihm gespeicherten Objekt, der ihn festlegt und für wen es ist. Ein "Javadoc -Typ / eine Kategorie" wird wie folgt verwendet:

/**
 * @AttributeKey
 * @scope request
 * @type com.acme.domain.User
 * @source com.acme.web.action.LoginAction#processLogin()
 * @for HomePage.jsp
 */
public static final String USER_KEY = ...;

Natürlich sollten die getriebenen Dokumentations -Tags zum Rendern in Englisch übersetzt werden. Ein wichtiger Teil des obigen Schemas ist das @AttributeKey -Tag. Dies würde die Dokumentationsautoren dazu zwingen, alle erforderlichen Felder oder Gesichtswarnmeldungen einzuschließen.

Ich bin mir fast sicher, dass so etwas für Java nicht existiert, aber würde es sich lohnen und welche anderen Sprachen / Dokumentationssysteme eine solche Funktion haben?

Answer 1

Ich sollte das denken Anmerkungen wäre besser zu der Art von Dingen, über die Sie sprechen (Semantik, Einschränkungen, Verträge usw.).