buen ejemplo de Javadoc [cerrada]

Question

¿hay un buen ejemplo de un archivo fuente que contiene Javadoc ?

No puedo encontrar un montón de buenos ejemplos de Javadoc en el Internet, me gustaría averiguar la sintaxis particular usado para crearlos, y asumir que puedo estudiar minuciosamente a través de la fuente de alguna biblioteca en alguna parte pero que parece como un montón de trabajo.

Answer 1

¿Qué tal el código fuente del JDK, pero se accede a través de una tercera parte como docjar? Por ejemplo, el Colecciones fuente .

De esa manera, no hay gran descarga.

Answer 2

La página Cómo escribir Doc Coments para la herramienta Javadoc contiene un buen número de buenos ejemplos. Una sección se llama Ejemplos de Doc Comentarios y contiene un buen número de usos.

Además, el Javadoc FAQ contiene un poco más de ejemplos para ilustrar las respuestas.

Answer 3

¿Qué hay de la JDK código fuente?

Answer 4

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

• siempre documentar sobre hilo de seguridad
• Siempre que documenta la inmutabilidad
• javadoc con ejemplos (como formateador )
• @Deprecation con qué y cómo reemplazar el elemento anotada

Answer 5

Tenga una mirada en la fuente marco de Primavera, que tiene excelentes javadocs

Answer 6

ANT, por ejemplo, - código fuente navegable en línea: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/DefaultLogger.java?view=co

Para elegir otros archivos a partir de: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528

Answer 7

Descarga las fuentes de Lucene y ver cómo lo hacen. Tienen buenas JavaDocs.

Answer 8

Si está utilizando Eclipse , entonces usted puede configurar su JDK (no JRE ) en JRE instalados , y luego usar tipo abierto ( Ctrl + Shift + T ), dan algo así como java.util.Collections

Answer 9

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

Answer 10

Si se instala un JDK y decide instalar fuentes también, el src.zip contiene la fuente de todas las clases de Java públicos. La mayoría de estos tienen bastante buena javadoc.

Answer 11

Si todo lo que buscas es la sintaxis, entonces esto puede ayudar:

Cómo escribir comentarios de documentación para el herramienta Javadoc