Etiquetas java

Solo disponible en BuenasTareas
  • Páginas : 2 (321 palabras )
  • Descarga(s) : 0
  • Publicado : 26 de enero de 2011
Leer documento completo
Vista previa del texto
Aparte de los comentarios propios, la utilidad javadoc nos proporciona una serie de etiquetas para completar la información que queremos dar de una determinada clase o método. Son lassiguientes:
 @author nombre (desde la versión 1.0 del JDK/SDK)
 Indica el autor de la clase en el argumento nombre. Un comentario de este tipo puede tener más de un autor en cuyo caso podemosusar tantas etiquetas de este tipo como autores hayan colaborado en la creación del código fuente.
@deprecated comentario (desde la versión 1.0 del JDK/SDK)
Añade un comentario indicando queeste API no debería volver a usarse, aunque aun siga perteneciendo a la distribución del SDK que estemos utilizando, por estar desautorizado o "desfasado".
{@link nombre etiqueta} (desde laversión 1.2 del JDK/SDK)
Inserta un enlace autocontenido que apunta a nombre. Esta etiqueta acepta exactamente la misma sintáxis que la etiqueta @see
@param parámetro descripción (desde laversión 1.0 del JDK/SDK)
Añade un parámetro y su descripción a la sección "Parameters" de la documentación HTML que generará.
@return descripción (desde la versión 1.0 del JDK/SDK)
Añade ala sección "Returns" de la documentación HTML que va a generar la descripción del tipo que devuelve el método.
@see referencia (desde la versión 1.0 del JDK/SDK)
Añade un cabecero "SeeAlso" con un enlace o texto que apunta a una referencia. El comentario de la documentación puede contener cualquier número de etiquetas de este tipo y todas, al generar la documentación, seagruparán bajo el mismo cabecero.

@since texto (desde la versión 1.1 del JDK/SDK)
Indica con texto desde cuándo se creó este paquete, clase o método.
@version version (desde la versión 1.0del JDK/SDK)
Añade un cabecero a la documentación generada con la versión de esta clase. Por versión, normalmente nos referimos a la versión del software que contiene esta clase o miembro.
tracking img