gutes Beispiel für Javadoc [geschlossen]
https://stackoverflow.com/questions/1079713
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianFrage
ist ein gutes Beispiel für eine Quelldatei mit Javadoc ?
ich viele gute Beispiele für Javadoc im Internet finden können, würde Ich mag nur die besondere Syntax ihnen erstellen herauszufinden, und ich nehme an, irgendwo durch die Quelle für einige Bibliothek Pore kann aber das scheint wie eine Menge Arbeit.
Lösung
Wie über den JDK-Quellcode, sondern durch eine dritte Partei wie docjar zugegriffen? Zum Beispiel kann die Sammlungen Quelle .
Auf diese Weise gibt es keine großen Download bereit.
Andere Tipps
Die Seite Wie Doc Coments für das Javadoc Tool schreiben enthält eine ganze Reihe von guten Beispielen. Ein Abschnitt heißt Beispiele für Doc Kommentare und enthält ziemlich viele Verwendungen.
Auch die Javadoc FAQ enthält einige mehr Beispiele, die Antworten zu erläutern.
Wie wäre es die JDK Quellcode?
Ich verwende einen kleinen Satz von Dokumentation Muster:
- immer die Dokumentation über Thread-Sicherheit
- immer Unveränderlichkeit dokumentieren
- javadoc mit Beispielen (wie Formatter )
- @Deprecation mit, warum und wie die kommentierten Elemente ersetzen
Hier finden Sie aktuelle Spring-Framework Quelle, es ausgezeichnete javadocs hat
ANT zum Beispiel - Quellcode durchsuchbaren online: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
So wählen Sie andere Dateien starten aus: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Laden Sie die Quellen von Lucene und sehen, wie sie es tun. Sie haben gute JavaDocs.
Wenn Sie mit Eclipse-, dann können Sie Setup Ihre JDK (nicht JRE ) in Installierte JREs und dann Open Type ( Strg + Umschalttaste + T ), geben so etwas wie java.util.Collections
Die Dokumentation von Google Guava der EventBus Paket und Klassen ist ein gutes Beispiel für Javadoc. Vor allem der Paketdokumentation mit dem Quick-Start ist gut geschrieben.
Wenn Sie eine JDK installieren und wählen Quellen zu installieren, enthält die src.zip die Quelle aller öffentlichen Java-Klassen. Die meisten von ihnen haben ziemlich gut javadoc.
Wenn Sie alle Ihre Suche die Syntax ist, dann kann dies helfen:
Wie Doc Kommentare zu der Javadoc-Tool schreiben
