Javadoc

draak25
22 de Julio del 2004
Hola a todos!

Necesito documentar unas clases en el codigo fuente, para luego pasar el Javadoc.

Podría alguien ponerme un ejemplo de como se documenta una clase con algún método, para que el javadoc genere la documentación en HTML, es decir, un ejemplo de como hay que poner los comentarios.
Muchas Gracias!


Victor
22 de Julio del 2004
Hola, aqui tienes un pequeño ejemplo del formato. para generar el javadoc solo tienes que abrir la consola y escribir javadoc nombre_de_archivo .java(teniendo en cuenta que el path te apunta al jdk/bin).

/**
* Returns parsed data in the form of a Vector of Vectors containing
* the returned fields inside of a Vector of returned rows.
*
* @param u URL to get parsed data from.
* @return Vector (records) of vectors (fields) of parsed data
* @exception JavaCGIBridgeTimeOutException If the retrieval times out
* @see #getRawCGIData
*/
public Vector getParsedData(URL u) throws JavaCGIBridgeTimeOutException {
return (getParsedData(u, null));
}