Документы Java через приватную переменную в классе

Question

public static class cls{
    private String text;
    public String getText(){
        return text;
    }
}

Можно ли отобразить переменную text в строках документации cls в Java без необходимости копировать содержимое?

Answer 1

Я не уверен, что вы пытаетесь сделать.Вы можете связать переменную из вашего JavaDoc одним из следующих способов:

/**
 * The cls class
 * see {@link cls#text} or
 * @see cls#text
 */
public static class cls {
    private String text;
...

Затем вы можете присоединить JavaDoc к этой переменной и описать, что вам нужно сказать.Насколько мне известно, нет способа просто отобразить строку кода внутри JavaDoc, кроме копирования и вставки.Но вы можете улучшить форматирование с помощью HTML, если хотите:

/**
 * The cls class, see this field:
 * <code>private String text;</code>
 */
public static class cls {
    private String text;
...

Надеюсь, это поможет, но остается вопрос: зачем вы хотите выставлять реализацию, если есть публичный геттер?