Есть ли способ определить "типы javadoc" - пользовательские параметры для членов?

Question

Вариант использования, о котором я могу подумать, следующий:

В типичном приложении обычно имеется много членов определенной категории, например, веб-приложение содержит множество констант, ключей атрибутов, классов действий, служб и т.д.Для каждой категории, чтобы обеспечить согласованность, полезно последовательно документировать их.

Рассмотрим константы, используемые для ключей атрибутов:

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

Каждый ключ атрибута обычно должен документировать свою область действия, тип объекта, хранящегося под ним, кто его устанавливает и для кого он предназначен."Тип / категория javadoc" будет использоваться следующим образом:

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

Конечно, отображаемые теги документации должны быть переведены на английский язык для рендеринга.Важной частью приведенной выше схемы является тег @AttributeKey - это вынудило бы авторов документации включать все необходимые поля или сталкиваться с предупреждающими сообщениями.

Я почти уверен, что такой вещи не существует для Java, но стоило бы ли это делать и какие другие языки / системы документации имеют такую функцию?

Answer 1

Я должен думать, что аннотации было бы лучше соответствовать тому, о чем вы говорите (семантика, ограничения, контракты и т.д.).