Хороший пример Джавадока

Есть ли хороший пример исходного файла, содержащего Javadoc?

Я могу найти много хороших примеров Javadoc в Интернете, я просто хотел бы узнать конкретный синтаксис, используемый для их создания, и предположить, что я могу порываться через источник какой-то библиотеки где-то, но это похоже на много работа.

ОТВЕТЫ

Ответ 1

Как насчет исходного кода JDK, но доступ к нему осуществляется через стороннюю сторону, например, docjar? Например, Источник коллекций.

Таким образом, нет большой загрузки.

Ответ 3

Как насчет JDK исходный код?

Ответ 4

Я использую небольшой набор шаблонов документации:

  • всегда документирует безопасность потоков
  • всегда документирует неизменность
  • javadoc с примерами (например Formatter)
  • @Deprecation с помощью WHY и HOW для замены аннотированного элемента

Ответ 6

Посмотрите на исходный код Spring, у него отличные javadocs

Ответ 7

Если вы используете Eclipse, вы можете настроить JDK (не JRE) в Установленные JRE, а затем использовать Открыть тип (Ctrl + Shift + T), дать что-то вроде java.util.Collections

Ответ 8

Загрузите источники Lucene и посмотрите, как они это делают. У них хорошие JavaDocs.

Ответ 9

Если вы устанавливаете JDK и выбираете также установку источников, src.zip содержит источник всех общедоступных классов Java. Большинство из них имеют довольно хороший javadoc.

Ответ 10

Документация пакета и классов Google Guava EventBus является хорошим примером Javadoc. Особенно хорошо написана документация по упаковке с быстрым запуском.