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

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

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

4b9b3361

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

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

100
ответ дан 03 июля '09 в 18:03
источник

Страница Как написать Doc Coments для Javadoc Tool содержит большое количество хороших примеров. Один раздел называется Примеры комментариев Doc и содержит довольно много обычаев.

Кроме того, Javadoc FAQ содержит еще несколько примеров, иллюстрирующих ответы.

36
ответ дан 03 июля '09 в 18:04
источник

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

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

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

2
ответ дан 06 марта '15 в 15:12
источник

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

1
ответ дан 03 июля '09 в 20:19
источник

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

1
ответ дан 18 авг. '16 в 12:23
источник