gutes Beispiel für Javadoc [geschlossen]

140

Gibt es ein gutes Beispiel für eine Quelldatei, die Javadoc enthält ?

Ich kann viele gute Beispiele für Javadoc im Internet finden. Ich möchte nur die spezielle Syntax herausfinden, mit der sie erstellt wurden, und davon ausgehen, dass ich irgendwo in der Quelle einer Bibliothek stöbern kann, aber das scheint eine Menge Arbeit zu sein.

java javadoc

— Jason S.
quelle

118

Wie wäre es mit dem JDK-Quellcode, auf den jedoch über einen Drittanbieter wie docjar zugegriffen wird? Zum Beispiel die Sammlungsquelle .

Auf diese Weise gibt es keinen großen Download.

— GaryF
quelle

1

Das ist eine gute Antwort, da Sammlungen von Josh und Neal geschrieben wurden.

— Cherouvim

Meine Antivirensoftware sagt, dass der docjar-Link unsicher ist. Kennen Sie andere Websites, auf denen die Sammlungsquelle enthalten ist? (Ich würde es gleiten lassen, wenn dies keine ziemlich verkehrsreiche Frage wäre :)

— Gordon Gustafson

2

Unter Windows enthält die JDK-Installation eine src.zipDatei mit dem Quellcode der Standardbibliotheken.

— Sri Harsha Chilakapati

Wie ist es für Dritte legal, urheberrechtlich geschützten Code zu verbreiten? Oder erlaubt das Urheberrecht das?

— ThePyroEagle

Dies ist das Hauptproblem bei externen Links: "Docjar.net ist für alle UNTEN."

— Buch des Zeus

39

Die Seite Schreiben von Dokumentkommentaren für das Javadoc-Tool enthält eine Reihe guter Beispiele. Ein Abschnitt heißt Beispiele für Dokumentkommentare und enthält einige Verwendungen.

Außerdem enthält die Javadoc-FAQ einige weitere Beispiele, um die Antworten zu veranschaulichen.

— Jared Oberhaus
quelle

Fixer

— Jeff Evans

9

Wie wäre es mit dem JDK- Quellcode?

— Butterhuhn
quelle

Das war mein offensichtlicher Gedanke, aber ich musste das ganze große Durcheinander herunterladen. :-(

— Jason S

5

Möglicherweise haben Sie es bereits, da es mit dem JDK geliefert wird (obwohl es eine Installationsoption ist).

— Michael Borgwardt

5

Ich verwende einen kleinen Satz von Dokumentationsmustern:

Immer über Thread-Sicherheit dokumentieren
immer die Unveränderlichkeit dokumentieren
Javadoc mit Beispielen (wie Formatter )
@Deprecation mit WARUM und WIE, um das mit Anmerkungen versehene Element zu ersetzen

— dfa
quelle

toller Hinweis, wie man die veralteten, thx

— Tobi Tiggers

4

Werfen Sie einen Blick auf Spring Framework Source, es hat ausgezeichnete Javadocs

— Gaël Marziou
quelle

3

ANT zum Beispiel - Quellcode online durchsuchbar: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

Um andere Dateien auszuwählen, beginnen Sie unter: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

— Nick Fortescue
quelle

2

Laden Sie die Quellen von Lucene herunter und sehen Sie, wie sie es tun. Sie haben gute JavaDocs.

— RichieHindle
quelle

2

Wenn Sie Eclipse verwenden , können Sie Ihr JDK (nicht JRE ) in installierten JREs einrichten und dann Open Type ( Ctrl+ Shift+ T) verwenden. Geben Sie so etwas anjava.util.Collections

— KrishPrabakar
quelle

1

Um das Gesagte zu ergänzen, konfigurieren die meisten IDEs Javadocs und Source automatisch, wenn Sie das JDK für die Verwendung konfigurieren. Dies gilt nicht nur für Eclipse.

— ThePyroEagle

2

Die Dokumentation des EventBus- Pakets und der Klassen von Google Guava ist ein gutes Beispiel für Javadoc. Besonders die Paketdokumentation mit dem Schnellstart ist gut geschrieben.

— Marvin Frommhold
quelle

1

Wenn Sie ein JDK installieren und auch Quellen installieren, enthält src.zip die Quelle ALLER öffentlichen Java-Klassen. Die meisten davon haben ziemlich gute Javadoc.

— Thorbjørn Ravn Andersen
quelle

1

Wenn Sie nur nach der Syntax suchen, kann dies helfen:

So schreiben Sie Dokumentkommentare für das Javadoc-Tool

— Jesse
quelle

1

danke, das ist mir aber schon bewusst (siehe meine Frage)

— Jason S

Doppelte Antwort ohne weitere nützliche Informationen.

— Alexey Ivanov