Как сделать Javadoc?

Question

Есть ли способ написать комментарий javadoc как для метода доступа, так и для мутатора (getter / setter), чтобы избежать дублирования информации о поле, лежащем в основе метода?

например:.

private float value;

/**
 * This value represents something.
 */
public float getValue () {
    return value;
}

/**
 * This value represents something.
 * @param    _value    A new value.
 */
public float setValue (float _value) {
    value = _value;
}

Кажется неэффективным и подверженным ошибкам дублировать информацию о поле 'value' в javadocs для getter и setter ....

Answer 1

Вы можете использовать тег @see, чтобы указывать из документации одного метода на другой, как это:

@see # setValue (float)

Eclipse поможет обеспечить завершение кода для javadoc, чтобы упростить созданиекомментарии.

Подробнее см. @see http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see