Scribd
Cargar
4 vistas5 páginas

Comentarios y Javadoc en Java

Este documento describe tres tipos de comentarios en Java, incluyendo comentarios de una sola línea, de múltiples líneas y de documentación. Explica que los comentarios de documentación generan automáticamente documentación cuando se usa la herramienta javadoc y proporcionan etiquetas como @author, @param y @return para describir elementos de código.

Cargado por

Juan
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
4 vistas5 páginas

Comentarios y Javadoc en Java

Este documento describe tres tipos de comentarios en Java, incluyendo comentarios de una sola línea, de múltiples líneas y de documentación. Explica que los comentarios de documentación generan automáticamente documentación cuando se usa la herramienta javadoc y proporcionan etiquetas como @author, @param y @return para describir elementos de código.

Cargado por

Juan
Derechos de autor
© All Rights Reserved
Nos tomamos en serio los derechos de los contenidos. Si sospechas que se trata de tu contenido, reclámalo aquí.
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd

JAVA

 1. Comentarios En Java hay tres tipos de comentarios:


 // comentarios para una sola línea

/* comentarios de una o
más líneas
*/
/** comentario de documentación, de una o más líneas
*/
 Los comentarios de documentación, colocados inmediatamente
antes de una declaración (de atributo o método), indican que ese
comentario ha de ser colocado en la documentación que se
genera automáticamente cuando se utiliza la herramienta de
Java, javadoc.
 Dichos comentarios sirven como descripción del elemento
declarado permitiendo generar una documentación de nuestras
clases escrita al mismo tiempo que se genera el código.
Tags de javadoc
Tag Descripción Aplica a
@see Nombre de clase asociada Clases, métodos o
variables
@author Nombre del autor Clases
@version Versión Clases
@param Nombre y descripción del Métodos
parámetro
@return Descripción del valor de Métodos
retorno
@exception Nombre y descripción de la Métodos
excepción.
Structure of the specification
Main Description

Tag Section
Comments are written in HTML
/**
* This is a <b>doc</b> comment.
* @see [Link]
*/
Note that tag names are case-sensitive. @See is a
mistaken usage - @see is correct.
Generating javadoc in Eclipse
 After writing the specification for all codes, use
“Project>Generate Javadoc…” menu item to generate
javadoc files.

También podría gustarte