Cómo crear Javadoc al comentar

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

Crear comentarios especiales javadoc . Para denotar un comentario javadoc , inicie el comentario con /** . Comentarios Javadoc suelen existir en la parte superior de un archivo, antes de las clases y antes de los 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 código. "" /*** Este es un comentario de javadoc . No tiene ninguna meta-tags javadoc todavía, pero lo hizo disparar el analizador javadoc para echar un vistazo a este comentario . * /""
2

Agregar API meta -tags (etiquetas que describen la propia API ) al comentar . Etiquetas API son los nombres de parámetros , descripciones , perfiles de excepción , descripciones valor de retorno, los nombres de método y método descripciones. Muchos IDEs incorporar estos datos en sus sugerencias de herramientas y otros ayudantes , así como que sea para su uso en HTML o en forma de comentario .
3

Utilice la descripción del método . Este meta -tag no tiene nombre tag: Es simplemente el comentario que precede a las otras etiquetas "" /*** Calcula la pendiente de una recta . . * /""
4

Incorporar descripciones de los parámetros . Estos se indican mediante el parámetro @ meta-tags , que debe ser seguido por un nombre y descripción del parámetro " . " /*** Calcula la pendiente de una recta . ** @ Param p1 Primer punto que describe la línea * @ param P2 Segundo punto que describe la línea * /""
5

Valor devuelto descripciones. Esto se denota por el @ return meta- tag y debe ser seguido por una descripción del valor de retorno " . " /*** Calcula la pendiente de una recta . ** @ Param p1 Primer punto que describe la línea * @ param P2 Segundo punto que describe la línea * @ Pendiente retorno de la línea como un float * /""
6

Agregar etiquetas atribución . Las etiquetas atribuyen el código a un autor específico . "" /*** Calcula la pendiente de una línea. ** @ Autor Jack Smith * @ param p1 Primer punto que describe la línea * @ param P2 Segundo punto que describe la línea * @ Pendiente retorno de la línea como un float * /""
7

Generar la documentación HTML. Si usted no está usando un IDE o simplemente quieres hacerlo manualmente , puede ejecutar el programa de línea de comandos javadoc desde el directorio del proyecto . Especifique el directorio de salida con la opción-d y pasarle una lista de archivos . Java (por lo general como un comodín ) " . " Javadoc -d * docs . Java " "