Está en la página 1de 1

Javadoc Netbeans.

Que es javadoc?
Javadoc es un paquete de desarrollo de java que nos genera
documentacin sobre nuestro proyecto de cada una de nuestras clases
en una jerarqua de rbol.
Su uso es recomendable para todo proyecto, incluido los proyectos
pequeos porque nos ayuda a tener siempre un cdigo bien
documentado, el nico contra que tiene su uso, es que es muy tedioso
documentar cada paso que se da al escribir el cdigo (en general por los
programadores flojos como yo), por lo dems, es una buena regla de
programacin.
Javadoc funciona por medio de MARCAS que le ayudan al API reconocer
las partes que queremos documentar y crear los archivos HTML.
Tags dentro de aplicacin.
@author - El nombre del autor del proyecto por ejemplo pepito :)
@version - La versin del proyecto
@see - Aade una referencia a una clase, mtodo o enlace web
@param - Nombre de parmetro utilizado en un mtodo incluido su
significado
@return - El resultado de un mtodo incluido su descripcin
@exception - Nombre de la excepcin mas una descripcin
@throws - Nombre de la excepcin mas una descripcin
@deprecated - Aade una alerta al usuario de que el mtodo que sigue
a continuacin ya no debe usarse y que ser eliminado en versiones
posteriores.

También podría gustarte