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.
Odpowiedzi:
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.
src.zipplik z kodem źródłowym bibliotek standardowych.
Strona How to Write Doc Coments for the Javadoc Tool zawiera wiele dobrych przykładów. Jedna sekcja nazywa się Przykłady komentarzy do dokumentów i zawiera kilka zastosowań.
Ponadto FAQ Javadoc zawiera więcej przykładów ilustrujących odpowiedzi.
A co z kodem źródłowym JDK ?
Używam małego zestawu wzorców dokumentacji:
Przyjrzyj się źródłom frameworka Springa, ma on doskonałe javadocs
Na przykład ANT - kod źródłowy do przeglądania online: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co
Aby wybrać inne pliki, zacznij od: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Pobierz źródła Lucene i zobacz, jak to robią. Mają dobre JavaDocs.
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
Dokumentacja pakietu i klas EventBus firmy Google Guava jest dobrym przykładem Javadoc. Szczególnie dobrze napisana jest dokumentacja pakietu zawierająca szybki start.
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.
Jeśli wszystko, czego szukasz, to składnia, może to pomóc: