llama - buen ejemplo de Javadoc
javadoc eclipse (11)
¿Qué tal el código fuente JDK ?
¿Hay algún 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 hojear el origen de alguna biblioteca en alguna parte, pero parece mucho trabajo.
¿Qué tal el código fuente JDK, pero se accede a través de un tercero como docjar? Por ejemplo, la fuente de Colecciones .
De esta forma, no hay una gran descarga.
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 por: 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.
Echa un vistazo a la fuente del marco de Spring, tiene excelentes javadocs
La documentación del paquete y 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.
La página How to Write Doc Coments para la herramienta Javadoc contiene una buena cantidad de buenos ejemplos. Una sección se llama Ejemplos de comentarios del doctor y contiene bastantes usos.
Además, las preguntas frecuentes de Javadoc contienen algunos ejemplos más para ilustrar las respuestas.
Si está utilizando Eclipse , puede configurar su JDK (no JRE ) en JRE instalados , y luego usar Open Type ( Ctrl + Shift + T ), dar algo como java.util.Collections
Si instala un JDK y elige también instalar fuentes, src.zip contiene el origen de TODAS las clases Java públicas. La mayoría de estos tienen bastante buen javadoc.
Si todo lo que busca es la sintaxis, esto puede ayudar:
Uso un pequeño conjunto de patrones de documentación:
- siempre documentando sobre seguridad de hilo
- siempre documentando la inmutabilidad
- javadoc con ejemplos (como el Formatter )
- @Deprecation con WHY y CÓMO reemplazar el elemento anotado