хороший пример Javadoc [закрыто]

142

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

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

java javadoc Джейсон С
источник

Ответы:

119

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

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

GaryF
источник
1
Это хороший ответ, поскольку сборники написаны Джошем и Нилом.
cherouvim
Моя антивирусная программа говорит, что ссылка на docjar небезопасна. Знаете ли вы какие-либо другие веб-сайты, на которых размещен источник коллекций? (Я бы оставил это в покое, если бы это не был вопрос с довольно интенсивным трафиком :)
Гордон Густафсон
2
Если в Windows, установка JDK содержит src.zipфайл с исходным кодом стандартных библиотек.
Шри Харша Чилакапати
Насколько законно распространение кода, защищенного авторским правом, третьим лицом? Или авторские права это позволяют?
ThePyroEagle
Это основная проблема с внешними ссылками: «Docjar.net ВЫКЛЮЧЕН для всех».
Book Of Zeus
39

На странице " Как писать комментарии к документации для инструмента Javadoc Tool" содержится большое количество хороших примеров. Один раздел называется « Примеры комментариев к документам» и содержит довольно много примеров использования.

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

Джаред Оберхаус
источник
Фиксированная ссылка (на данный момент): oracle.com/technetwork/java/javase/documentation/…
Джефф Эванс,
9

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

цыпленок
источник
это была моя очевидная мысль, но мне пришлось бы скачать весь большой беспорядок. :-(
Jason S
5
Скорее всего, он у вас уже есть, поскольку он поставляется с JDK (хотя это вариант установки).
Майкл Боргвардт
5

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

  • всегда документируют безопасность потоков
  • всегда документируют неизменность
  • javadoc с примерами (например, Formatter )
  • @Deprecation с ПОЧЕМУ и КАК заменить аннотированный элемент
DFA
источник
отличный совет включить КАК заменить устаревшее,
спасибо
4

Взгляните на источник Spring framework, у него отличные javadocs

Гаэль Марзиу
источник
2

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

РичиХиндл
источник
2

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

КришПрабакар
источник
1
Чтобы добавить к сказанному, большинство IDE автоматически настраивают javadocs и источник, когда вы настраиваете JDK для их использования. Это относится не только к Eclipse.
ThePyroEagle
2

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

Марвин Фроммхолд
источник
1

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

Торбьёрн Равн Андерсен
источник