buen ejemplo de Javadoc [cerrado]

140

¿Hay un buen ejemplo de un archivo fuente que contenga Javadoc ?

Puedo encontrar muchos buenos ejemplos de Javadoc en Internet, solo me gustaría descubrir la sintaxis particular utilizada para crearlos, y asumir que puedo analizar la fuente de alguna biblioteca en algún lugar, pero eso parece mucho trabajo.

java javadoc Jason S
fuente

Respuestas:

118

¿Qué tal el código fuente JDK, pero accedido a través de un tercero como docjar? Por ejemplo, la fuente de Colecciones .

De esa manera, no hay gran descarga.

GaryF
fuente
1
Esa es una buena respuesta ya que las colecciones fueron escritas por Josh y Neal.
cherouvim
Mi software antivirus dice que el enlace docjar no es seguro. ¿Conoces otros sitios web que incluyan la fuente de colecciones? (Lo dejaría pasar si esta no fuera una pregunta de mucho tráfico :)
Gordon Gustafson el
2
Si está en Windows, la instalación de JDK contiene un src.ziparchivo con el código fuente de las bibliotecas estándar.
Sri Harsha Chilakapati
¿Cómo es legal que un tercero distribuya código protegido por derechos de autor? ¿O los derechos de autor lo permiten?
ThePyroEagle
Este es el principal problema con los enlaces externos, "Docjar.net está ABAJO para todos".
Libro de Zeus el
9

¿Qué tal el código fuente JDK ?

pollo de mantequilla
fuente
ese era mi pensamiento obvio, pero tenía que descargar todo el gran desastre. :-(
Jason S
55
Es probable que ya lo tenga, ya que viene con el JDK (aunque es una opción de instalación).
Michael Borgwardt
5

Yo uso un pequeño conjunto de patrones de documentación:

  • siempre documentando sobre seguridad de hilos
  • siempre documentando la inmutabilidad
  • javadoc con ejemplos (como Formatter )
  • @Deprecation con POR QUÉ y CÓMO reemplazar el elemento anotado
dfa
fuente
gran sugerencia para incluir CÓMO reemplazar el obsoleto, gracias
Tobi Tiggers
4

Eche un vistazo a la fuente de Spring Framework, tiene excelentes javadocs

Gaël Marziou
fuente
2

Descargue las fuentes de Lucene y vea cómo lo hacen. Tienen buenos JavaDocs.

RichieHindle
fuente
2

Si está utilizando Eclipse , puede configurar su JDK (no JRE ) en JRE instalados , y luego usar Tipo abierto ( Ctrl+ Shift+ T), dar algo comojava.util.Collections

KrishPrabakar
fuente
1
Para agregar a lo que se dijo, la mayoría de los IDE configuran automáticamente javadocs y fuente cuando configura el JDK para que lo usen. Esto no solo se aplica a Eclipse.
ThePyroEagle
2

La documentación del paquete y las clases EventBus de Google Guava es un buen ejemplo de Javadoc. Especialmente la documentación del paquete con el inicio rápido está bien escrita.

Marvin Frommhold
fuente
1

Si instala un JDK y elige instalar las fuentes también, src.zip contiene la fuente de TODAS las clases públicas de Java. La mayoría de estos tienen bastante buen javadoc.

Thorbjørn Ravn Andersen
fuente