хороший приклад Javadoc [закрито]


140

чи є хороший приклад вихідного файлу, що містить Javadoc ?

Я можу знайти багато хороших прикладів Javadoc в Інтернеті, я просто хотів би дізнатися конкретний синтаксис, який використовується для їх створення, і припустити, що я можу десь переглядати джерело якоїсь бібліотеки, але це здається великою роботою.

Відповіді:


118

Як щодо вихідного коду JDK, але доступ до якого здійснюється через сторонніх організацій, таких як docjar? Наприклад, джерело Колекції .

Таким чином, великих завантажень немає.


1
Це хороша відповідь з колекцій, де написані Джош та Ніл.
cherouvim

Моє антивірусне програмне забезпечення говорить про те, що посилання на docjar небезпечно. Чи знаєте ви про інші веб-сайти, які містять джерело колекцій? (Я б дозволив, щоб це просунулося, якщо це не досить запитне питання :)
Гордон Густафсон

2
Якщо у Windows встановлення JDK містить src.zipфайл із вихідним кодом стандартних бібліотек.
Шрі Харша Чілакапаті

Як законно розповсюджувати захищений авторським правом код третьої сторони? Або авторські права дозволяють це?
ThePyroEagle

Це основна проблема із зовнішніми посиланнями: "Docjar.net ВІДНОВА для всіх".
Книга Зевса

39

Сторінка Як писати документи Doc для інструменту Javadoc містить велику кількість хороших прикладів. Один розділ називається Приклади коментарів до документа і містить досить багато звичаїв.

Також FAQ FAQ про Javadoc містить ще кілька прикладів для ілюстрації відповідей.


Виправлене посилання (поки що): oracle.com/technetwork/java/javase/documentation/…
Джефф Еванс

9

Як щодо вихідного коду JDK ?


це було моєю очевидною думкою, але мені доведеться завантажити весь великий безлад. :-(
Джейсон S

5
Швидше за все, у вас його вже є, оскільки він поставляється з JDK (хоча це варіант установки).
Майкл Боргвардт

5

Я використовую невеликий набір моделей документації:

  • завжди документування про безпеку ниток
  • завжди документуючи незмінність
  • javadoc з прикладами (як формат )
  • @ Означення ЧОМУ та ЯК замінити елемент із зазначенням

чудовий натяк на те, як включити ЯК замінити застарілий, thx
Tobi




2

Якщо ви використовуєте Eclipse , то ви можете встановити JDK (не JRE ) у встановлених JRE , а потім використовувати Open Type ( Ctrl+ Shift+ T), дати щось подібнеjava.util.Collections


1
Щоб додати до сказаного, більшість IDE автоматично налаштовують javadocs і джерело, коли ви налаштовуєте JDK для їх використання. Це стосується не лише затемнення.
ThePyroEagle

2

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


1

Якщо ви встановите JDK і також вирішите встановити джерела, src.zip містить джерело ВСІХ загальнодоступних класів Java. Більшість із них мають досить хороший явадок.


Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.