Как обрабатывать ситуации, когда на одно значение следует ссылаться в нескольких Javadocs? [закрыто]JAVA

Программисты JAVA общаются здесь
Ответить
Anonymous
 Как обрабатывать ситуации, когда на одно значение следует ссылаться в нескольких Javadocs? [закрыто]

Сообщение Anonymous »

Предположим, у меня есть несколько классов с упоминанием Javadoc:
  • то же значение (не используется в коде, поэтому я не могу ссылаться на него только по @link или @value)
  • или ту же ссылку на внешнюю документацию (которая потенциально может измениться)
Можно ли создать специальный класс для одного источника истины, например JavadocConstants.java, для хранения необходимых значений (которые используются только в javadoc) для ссылки в javadoc для упрощения рефакторинга?
Пример такого класса

Код: Выделить всё

public final class JavadocConstnats {

public static final String MENU_LABEL1 = "label_value";
public static final String URL1 = "https://url1";
}
На который затем можно ссылаться в javadoc для разных классов

Код: Выделить всё

/**
* Example javadoc:
*
* 
Used on site at {@value JavadocConstants#MENU_LABEL1} menu.
*
* External doc: {@value JavadocConstants#URL1}
*/
Видели ли вы нечто подобное в популярных Java-проектах? Упоминается ли эта практика в книгах по чистому коду Java?
Как бы вы поступили в таких ситуациях, когда на одно значение приходится ссылаться в нескольких документах Java?

Подробнее здесь: https://stackoverflow.com/questions/798 ... le-javadoc
Ответить

Быстрый ответ

Изменение регистра текста: 
Смайлики
:) :( :oops: :roll: :wink: :muza: :clever: :sorry: :angel: :read: *x)
Ещё смайлики…
   
К этому ответу прикреплено по крайней мере одно вложение.

Если вы не хотите добавлять вложения, оставьте поля пустыми.

Максимально разрешённый размер вложения: 15 МБ.

Вернуться в «JAVA»