Java - Busco manuales sobre JavaDoc

 
Vista:

Busco manuales sobre JavaDoc

Publicado por Marcos Regueras (2 intervenciones) el 21/12/2001 04:55:34
Hola, buenos dias a todos.

Mi problema es que tengo que empezar a documentar las clases
que hago (documentar con el JavaDoc) y la documentacion que viene con el JDK1.3.1 es mas bien escasa. Tambien tengo varios libros y documentos, explican muy bien el lenguaje, pero no sus
herramientas (como puede ser JavaDoc). Mi pregunta es si me
podeis dar direcciones con ejemplos (sencillos) y manuales sobre
como utilizar la herramienta JavaDoc.

Muchas gracias y feliz Navidad.
Valora esta pregunta
Me gusta: Está pregunta es útil y esta claraNo me gusta: Está pregunta no esta clara o no es útil
0
Responder

RE:Busco manuales sobre JavaDoc

Publicado por Xavi Canal (241 intervenciones) el 21/12/2001 09:53:03
Nas,

yo aprendí a manejarlo de la siguiente manera:

primero ejecútalo sin parámetros y veras todas las posibilidades,
tiene lo típico (directorio a dejar los HTML, ...) más alguna cosa
específica suya (poner los deprecateds, ...)

La nomenclatura que debes usar en el código es muy fácil, en el
directorio lib (creo) está el fichero src.jar, pués bien, este fichero
es el código fuente de las clases Java (ej: Jbuton.java, ArrayList.java,
...) es código hecho en Java (evidente), abre el fichero con el Winzip (si usas Windows, claro) y descomprime cualquier clase. Fíjate en la
manera de poner los comentarios para que lo entienda el javadoc:

/**
*
* Descripcion de lo que sea
*
*/

Tiene que empezar con /** (2 asteriscos), ya verás que para los
métodos puedes usar cosas como:

/**
*
* Descripcion del método
*
* @param numero Entero que indica lo que sea ....
* @param loquesea Bla, bla, bla ,....
* @return Un objeto que bla bla bla
*/

Como verás es muy fácil, no necesitas muchos manuales para
aprender. El estilo de prueba y ensayo suele ser el mejor

att. Xavi Canal
Valora esta respuesta
Me gusta: Está respuesta es útil y esta claraNo me gusta: Está respuesta no esta clara o no es útil
0
Comentar