Автоматическое распространение Javadoc'ов частного поля на геттеры / сеттеры? - PullRequest
9 голосов
/ 13 июля 2011

Я задокументировал свои закрытые поля bean-компонентов с помощью Javadoc, объясняя, для чего предназначено каждое поле.Могу ли я как-то распространить эти документы в соответствии с получателями / установщиками, чтобы уменьшить дублирование документации?По крайней мере, для этого есть какой-нибудь макрос Javadoc?

Ответы [ 2 ]

5 голосов
/ 13 июля 2011

Вы можете связать комментарий javadoc для методов получения и установки в приватное поле, добавив ссылку на Javadoc:

{@link Class#field}

Однако я бы не стал этого рекомендовать. Как говорили предыдущие комментаторы, я бы просто задокументировал методы получения и установки правильно. Javadoc документирует ваш публичный API, к которому могут принадлежать геттеры и сеттеры. Ваши личные поля не принадлежат общедоступному API.

0 голосов
/ 12 декабря 2014

Вы можете рассмотреть некоторые инструменты времени компиляции, такие как Lombok:

http://projectlombok.org/features/GetterSetter.html

...