C'è un modo per definire 'tipi' javadoc - parametri personalizzati per i membri?

Question

Il caso d'uso mi viene in mente è la seguente:

In una tipica applicazione, normalmente ci sono molti membri di una determinata categoria, ad esempio, un'applicazione web contiene molte costanti attribuiscono chiavi, corsi di azione, servizi, ecc, per ogni categoria, per mantenere la coerenza, è utile per documentarle in modo coerente.

Considerate le costanti utilizzate per le chiavi degli attributi:

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

Ogni chiave di attributo in genere dovrebbe documentare il campo di applicazione, il tipo di oggetto memorizzato sotto di essa, che lo imposta, e chi è per. Un 'tipo javadoc / categoria' sarebbe stato utilizzato come segue:

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

Naturalmente, i tag di documentazione resi dovrebbe essere tradotto in inglese per il rendering. Una parte importante del programma di cui sopra è il tag @AttributeKey -. Questo costringerebbe gli scrittori di documentazione per includere tutti i campi obbligatori o messaggi di avviso volto

Sono quasi positivo che una cosa del genere non esiste per Java, ma sarebbe utile e quali altre lingue / sistemi di documentazione hanno una tale caratteristica?

Answer 1

dovrei pensare che annotazioni sarebbe una migliore corrispondenza per il tipo di cosa si sta parlando (semantica, vincoli, contratti, ecc.).