dobry przykład Javadoc [zamknięty]

140

czy istnieje dobry przykład pliku źródłowego zawierającego Javadoc ?

Mogę znaleźć wiele dobrych przykładów Javadoc w Internecie, chciałbym tylko dowiedzieć się, jaka składnia została użyta do ich stworzenia i założyć, że mogę gdzieś przeszukać źródła jakiejś biblioteki, ale wydaje się, że to dużo pracy.

java javadoc Jason S.
źródło

Odpowiedzi:

118

A co z kodem źródłowym JDK, ale dostęp do niego uzyskuje się za pośrednictwem strony trzeciej, takiej jak docjar? Na przykład źródło kolekcji .

W ten sposób nie ma dużego pobierania.

GaryF
źródło
1
To dobra odpowiedź, ponieważ kolekcje zostały napisane przez Josha i Neala.
cherouvim
Moje oprogramowanie antywirusowe informuje, że łącze docjar jest niebezpieczne. Czy znasz jakieś inne strony internetowe, które zawierają źródło kolekcji? (Zrobiłbym to, gdyby nie było to pytanie o dużym natężeniu ruchu :)
Gordon Gustafson,
2
W systemie Windows instalacja JDK zawiera src.zipplik z kodem źródłowym bibliotek standardowych.
Sri Harsha Chilakapati
W jaki sposób osoba trzecia może rozpowszechniać kod chroniony prawem autorskim? A może prawa autorskie na to pozwalają?
ThePyroEagle
To jest główny problem z linkami zewnętrznymi: „Docjar.net nie działa dla wszystkich”.
Księga Zeusa
9

A co z kodem źródłowym JDK ?

kurczaka w maśle
źródło
to była moja oczywista myśl, ale musiałbym pobrać cały wielki bałagan. :-(
Jason S,
5
Prawdopodobnie już to masz, ponieważ jest dostarczany z JDK (chociaż jest to opcja instalacji).
Michael Borgwardt,
5

Używam małego zestawu wzorców dokumentacji:

  • zawsze dokumentuje bezpieczeństwo nici
  • zawsze dokumentując niezmienność
  • javadoc z przykładami (np. Formatter )
  • @Deprecation z DLACZEGO i JAK zamienić element z adnotacją
dfa
źródło
świetna wskazówka, aby dołączyć JAK wymienić przestarzałe, dzięki
Tobi Tiggers
4

Przyjrzyj się źródłom frameworka Springa, ma on doskonałe javadocs

Gaël Marziou
źródło
2

Pobierz źródła Lucene i zobacz, jak to robią. Mają dobre JavaDocs.

RichieHindle
źródło
2

Jeśli używasz Eclipse , możesz skonfigurować swój JDK (nie JRE ) w zainstalowanych JRE , a następnie użyć Open Type ( Ctrl+ Shift+ T), podać coś w rodzajujava.util.Collections

KrishPrabakar
źródło
1
Aby dodać do tego, co zostało powiedziane, większość IDE automatycznie konfiguruje javadoc i źródło podczas konfigurowania JDK do użytku. Dotyczy to nie tylko Eclipse.
ThePyroEagle
2

Dokumentacja pakietu i klas EventBus firmy Google Guava jest dobrym przykładem Javadoc. Szczególnie dobrze napisana jest dokumentacja pakietu zawierająca szybki start.

Marvin Frommhold
źródło
1

Jeśli zainstalujesz pakiet JDK i zdecydujesz się również zainstalować źródła, plik src.zip zawiera źródło WSZYSTKICH publicznych klas Java. Większość z nich ma całkiem niezły javadoc.

Thorbjørn Ravn Andersen
źródło