Как получить доступ к javadoc?

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

e.g.:

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 для методов получения и установки ....


person ericsoco    schedule 22.12.2011    source источник
comment
Обсуждение этой темы есть здесь.   -  person Beau Grantham    schedule 23.12.2011
comment
спасибо, красавчик. решил, что об этом спрашивали раньше, но не смог найти. Я проголосовал за закрытие своего вопроса.   -  person ericsoco    schedule 28.12.2011


Ответы (1)


Вы можете использовать тег @see для перехода от документации одного метода к другому следующим образом:

@see # setValue (float)

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

Для получения дополнительной информации @ см. http://docs.oracle.com/javase/1.5.0/docs/tooldocs/windows/javadoc.html#@see

person centic    schedule 22.12.2011