buon esempio di Javadoc [chiuso]

140

c'è un buon esempio di un file sorgente contenente Javadoc ?

Posso trovare molti buoni esempi di Javadoc su Internet, vorrei solo scoprire la sintassi particolare usata per crearli, e presumere che io possa analizzare la fonte di alcune librerie da qualche parte, ma sembra un sacco di lavoro.

java  javadoc 
— Jason S
fonte

Risposte:

118

Che ne dite del codice sorgente JDK, ma vi si accede da una terza parte come docjar? Ad esempio, l' origine Collezioni .

In questo modo, non esiste un grande download.

— GaryF
fonte
1
Questa è una buona risposta da quando le raccolte sono state scritte da Josh e Neal.
— Cherouvim,
Il mio software antivirus dice che il collegamento docjar non è sicuro. Conoscete altri siti Web che presentano la fonte delle raccolte? (Lascerei che scivolasse se questa non fosse una domanda abbastanza trafficata :)
— Gordon Gustafson,
2
Se su Windows, l'installazione di JDK contiene un src.zipfile con il codice sorgente delle librerie standard.
— Sri Harsha Chilakapati,
In che modo è legale distribuire un codice protetto da terzi? O il copyright lo consente?
— ThePyroEagle
Questo è il problema principale con i link esterni, "Docjar.net è DOWN per tutti".
— Libro di Zeus del
9

Che ne dici del codice sorgente JDK ?

— pollo al BURRO
fonte
quello era il mio ovvio pensiero, ma avrei dovuto scaricare l'intero casino. :-(
— Jason S,
5
È probabile che tu l'abbia già, poiché viene fornito con JDK (sebbene sia un'opzione di installazione).
— Michael Borgwardt,
5

Uso un piccolo set di schemi di documentazione:

  • documentando sempre sulla sicurezza dei thread
  • documentando sempre l'immutabilità
  • javadoc con esempi (come Formatter )
  • @ Deprecazione con PERCHÉ e COME sostituire l'elemento annotato
— dfa
fonte
ottimo suggerimento per includere COME sostituire il deprecato, grazie
— Tobi Tiggers
2

Se stai usando Eclipse , puoi configurare il tuo JDK (non JRE ) in JRE installati , quindi usare Open Type ( Ctrl+ Shift+ T), dare qualcosa di similejava.util.Collections

— KrishPrabakar
fonte
1
Per aggiungere ciò che è stato detto, la maggior parte degli IDE configura automaticamente javadocs e source quando configuri JDK affinché possano essere utilizzati. Questo non vale solo per Eclipse.
— ThePyroEagle
2

La documentazione del pacchetto e delle classi EventBus di Google Guava è un buon esempio di Javadoc. Soprattutto la documentazione del pacchetto con l'avvio rapido è ben scritta.

— Marvin Frommhold
fonte
1

Se si installa un JDK e si sceglie di installare anche i sorgenti, src.zip contiene l'origine di TUTTE le classi pubbliche Java. La maggior parte di questi ha giavadoc abbastanza buono.

— Thorbjørn Ravn Andersen
fonte
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.