Как использовать 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; 
} 

Кажется неэффективным и подверженные ошибкам дублировать информацию о поле «значения» в Javadocs для геттера и сеттера ....

Answer 1

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

@see # setValue (float) 

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

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