Есть ли хороший пример исходного файла, содержащего Javadoc?
Я могу найти много хороших примеров Javadoc в Интернете, я просто хотел бы узнать конкретный синтаксис, используемый для их создания, и предположить, что я могу порываться через источник какой-то библиотеки где-то, но это похоже на много работа.
Как насчет исходного кода JDK, но доступ к нему осуществляется через стороннюю сторону, например, docjar? Например, Источник коллекций.
Таким образом, нет большой загрузки.
Страница Как написать Doc Coments для Javadoc Tool содержит большое количество хороших примеров. Один раздел называется Примеры комментариев Doc и содержит довольно много обычаев.
Кроме того, Javadoc FAQ содержит еще несколько примеров, иллюстрирующих ответы.
Как насчет JDK исходный код?
Я использую небольшой набор шаблонов документации:
ANT например - исходный код доступен в Интернете: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
Чтобы выбрать другие файлы, начинайте с: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Посмотрите на исходный код Spring, у него отличные javadocs
Если вы используете Eclipse, вы можете настроить JDK (не JRE) в Установленные JRE, а затем использовать Открыть тип (Ctrl + Shift + T), дать что-то вроде java.util.Collections
Загрузите источники Lucene и посмотрите, как они это делают. У них хорошие JavaDocs.
Если вы устанавливаете JDK и выбираете также установку источников, src.zip содержит источник всех общедоступных классов Java. Большинство из них имеют довольно хороший javadoc.
Документация пакета и классов Google Guava EventBus является хорошим примером Javadoc. Особенно хорошо написана документация по упаковке с быстрым запуском.
Если все, что вы ищете, это синтаксис, то это может помочь: