Est-il possible de définir « types javadoc » - paramètres personnalisés pour les membres?

Question

Le cas d'utilisation, je peux penser est le suivant:

Il est dans une application typique, il y a généralement beaucoup de membres d'une certaine catégorie, par exemple, une application Web contient de nombreuses constantes d'attributs clés, des cours d'action, les services, etc. Pour chaque catégorie, pour maintenir la cohérence, utile pour les documenter constamment.

Considérez les constantes utilisées pour les clés d'attributs:

/**
 * 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";

Chaque clé d'attribut doit généralement documenter son champ d'application, le type d'objet stocké en dessous, qui fixe, et qui c'est pour. serait utilisé comme 'type javadoc / catégorie' suit:

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

Bien sûr, les balises de documentation rendus doivent être traduits en anglais pour le rendu. Une partie importante du schéma ci-dessus est la balise @AttributeKey -. Cela forcerait les rédacteurs de documentation pour inclure tous les champs obligatoires ou des messages d'avertissement face

Je suis presque certain qu'une telle chose n'existe pas pour Java, mais serait-il utile et quelles autres langues / systèmes de documentation ont une telle fonctionnalité?

Answer 1

Je pense que annotations serait un meilleur match pour le genre de chose dont vous parlez (sémantique, les contraintes, les contrats, etc.).