А вот скажем есть класс A
и у него есть приватное поле field
. И есть геттер и сеттер: getField
и setField
. Насколько корректно в javadoc у них писать что они возвращают/устанавливают field
? Ведь сам`field` приватный, и в документацию его вроде как включать не хорошо?
Большое спасибо!
Лучше семантически описывать. Например "устанавливает возраст пользователя" и "возвращает возраст пользователя". Прелесть геттеров и сеттеров как раз в том, что никого не волнует как оно реально хранится. В будущем это может стать делегатом к вложенному объекту, например