¿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.
Respuestas:
¿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.
src.ziparchivo con el código fuente de las bibliotecas estándar.
La página Cómo escribir comentarios de documentos para la herramienta Javadoc contiene una buena cantidad de buenos ejemplos. Una sección se llama Ejemplos de comentarios de documentos y contiene bastantes usos.
Además, las preguntas frecuentes de Javadoc contienen algunos ejemplos más para ilustrar las respuestas.
¿Qué tal el código fuente JDK ?
Yo uso un pequeño conjunto de patrones de documentación:
Eche un vistazo a la fuente de Spring Framework, tiene excelentes javadocs
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, comience desde: http://svn.apache.org/viewvc/ant/core/trunk/src/main/org/apache/tools/ant/?pathrev=761528
Descargue las fuentes de Lucene y vea cómo lo hacen. Tienen buenos JavaDocs.
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
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.
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.
Si todo lo que busca es la sintaxis, esto puede ayudar:
Cómo escribir comentarios de documentos para la herramienta Javadoc