"Сводка по полю" на Java Api Doc - PullRequest
4 голосов
/ 10 ноября 2010

когда я читаю документацию по API Java, я вижу поле с именем «Сводка поля». Для чего используется эта часть?

Какая польза от константы и классов в этом поле?

спасибо.

1 Ответ

3 голосов
/ 10 ноября 2010

«Сводка полей» сгенерированной страницы Javadoc предназначена для суммирования (обычно общедоступных и защищенных) полей класса и предоставления ссылок на более подробные описания полей далее по странице.Как и в случае с методами, текст в разделе сводки для полей состоит из первого предложения из соответствующего раздела подробностей.

Поскольку в Java сложилась хорошая практика, которая означает, что изменяемые поля обычно являются закрытыми, обычно это простоконстанты, которые там задокументированы (например, java.lang.Double имеет несколько), хотя есть некоторые классы, которые имеют изменяемые поля (например, javax.xml.ws.Holder имеет один, и класс достаточнопросто, это не проблема).

...