Existe uma maneira de definir parâmetros personalizados de 'tipos javadoc' para membros?

Question

O caso de uso em que consigo pensar é o seguinte:

Em um aplicativo típico, geralmente existem muitos membros de uma determinada categoria, por exemplo, um aplicativo da Web contém muitas chaves de atributo de constantes, classes de ação, serviços etc. para cada categoria, para manter a consistência, é útil documentá -las de forma consistente.

Considere as constantes usadas para as teclas de atributo:

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

Cada chave de atributo deve normalmente documentar seu escopo, o tipo de objeto armazenado sob ele, que o define e para quem é. Um 'Javadoc tipo / categoria' seria usado da seguinte forma:

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

Obviamente, as tags de documentação renderizadas devem ser traduzidas para o inglês para renderização. Uma parte importante do esquema acima é a etiqueta @AttributeKey - isso forçaria os escritores de documentação a incluir todos os campos necessários ou mensagens de aviso.

Tenho quase certeza de que isso não existe para Java, mas valeria a pena e quais outros idiomas / sistemas de documentação têm esse recurso?

Answer 1

Eu deveria pensar que anotações Seria uma correspondência melhor para o tipo de coisa que você está falando (semântica, restrições, contratos etc.).