¿Hay alguna forma de definir 'tipos de javadoc' - parámetros personalizados para los miembros?

Question

El caso de uso en el que puedo pensar es el siguiente:

En una aplicación típica, generalmente hay muchos miembros de una determinada categoría, por ejemplo, una aplicación web contiene muchas claves de atributo de constantes, clases de acción, servicios, etc. Para cada categoría, para mantener la coherencia, es útil documentarlas de manera consistente.

Considere las constantes utilizadas para las 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 clave de atributo generalmente debe documentar su alcance, el tipo de objeto almacenado debajo, quién lo establece y para quién es. Se utilizaría un 'tipo javadoc / categoría' de la siguiente manera:

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

Por supuesto, las etiquetas de documentación renderizadas deben traducirse al inglés para la representación. Una parte importante del esquema anterior es la etiqueta @attributekey: esto obligaría a los escritores de documentación a incluir todos los campos requeridos o mensajes de advertencia de cara.

Estoy casi seguro de que tal cosa no existe para Java, pero ¿valdría la pena y qué otros idiomas / sistemas de documentación tienen tal característica?

Answer 1

Debería pensar que anotaciones Sería una mejor coincidencia para el tipo de cosas que estás hablando (semántica, limitaciones, contratos, etc.).