Cómo crear Javadoc al comentar

Javadoc es el estándar de facto para la generación de la documentación del código fuente. Es una herramienta para crear documentos HTML a partir de los comentarios con un formato específico en el código Java. Esto puede ser usado para generar la interfaz de programación de aplicaciones estructurada (API) de la documentación de forma automática, dar algunas pistas al IDE o para la atribución de paquetes, clases y métodos. Esencialmente, es una manera de comentar las descripciones de parámetros, lo que escribieron, y que la culpa si se rompe. Java viene con el programa javadoc de línea de comandos para generar la documentación HTML, pero la mayoría de los entornos de desarrollo integrado (IDE Java) también tienen esta integrado.

Instrucciones

1 Crear comentarios javadoc especiales. Para denotar un comentario javadoc, iniciar el comentario con /. Comentarios Javadoc normalmente existen en la parte superior de un archivo, antes de clases y antes de métodos. Ya que está diseñado para la documentación de la API completa, no es raro ver a los archivos con más comentarios javadoc que el código. ""/

Este es un comentario Javadoc. No tiene ningún javadoc meta-tags aún, pero lo hizo desencadenar el analizador javadoc para echar un vistazo a este comentario.
/ ""

2 Añadir API de meta-tags (etiquetas que describen la API de sí mismo), al comentar. etiquetas API son los nombres de parámetros, descripciones, perfiles de excepción, las descripciones de valor de retorno, los nombres de métodos y descripciones de los métodos. Muchos IDE incorporan estos datos en sus extremidades de herramienta y otros ayudantes, así como que sea para su uso en formulario HTML o comentario.

3 Utilice la descripción del método. Este meta-tag no tiene ninguna etiqueta con su nombre: Es simplemente el comentario que viene antes de las otras etiquetas. ""/*


Computes the slope of a line.
*/"" ""/*
Computes the slope of a line.
*/""

4 Incorporar descripciones de los parámetros. Estos se designan con los @param meta-tags, que deben ser seguidos por un nombre y descripción del parámetro. ""/*


Computes the slope of a line.

@param p1 First point that describes the line
@param p2 Second point that describes the line
/"" ""/*
Computes the slope of a line.

@param p1 First point that describes the line
@param p2 Second point that describes the line
/""

5 Volver descripciones de valor. Esto se denota por el meta-etiqueta @return y debe ser seguido por una descripción del valor de retorno. ""/*


Computes the slope of a line.

@param p1 First point that describes the line
@param p2 Second point that describes the line
@return Slope of the line as a float
*/"" ""/*
Computes the slope of a line.

@param p1 First point that describes the line
@param p2 Second point that describes the line
@return Slope of the line as a float
*/""

6 Añadir etiquetas atribución. Las etiquetas atribuyen el código a un autor específico. ""/*


Computes the slope of a line.

@Author Jack Smith
@param p1 First point that describes the line
@param p2 Second point that describes the line
@return Slope of the line as a float
/"" ""/*
Computes the slope of a line.

@Author Jack Smith
@param p1 First point that describes the line
@param p2 Second point that describes the line
@return Slope of the line as a float
/""

7 Generar la documentación HTML. Si usted no está usando un IDE o lo que desea es hacerlo de forma manual, puede ejecutar el programa de línea de comandos javadoc desde el directorio del proyecto. Especificar el directorio de salida con el conmutador -d y pasarlo una lista de archivos .java (por lo general como un comodín). ""javadoc -d docs *.java""

Consejos y advertencias

• Cuando se está usando un IDE, documentación HTML es, probablemente, realiza automáticamente como parte del proceso de construcción. Consulte la documentación del IDE para confirmar esto.
• comentarios multilínea en Java tradicionalmente comienzan con /
• , Pero el carácter de asterisco extra en Javadoc señala el analizador javadoc para empezar a buscar javadoc meta-tags.