- @author nombreAutor descripción
- @version número de version descripción
- @param nombreParámetro descripción.
- @return descripción.
- @see nombre descripción. Cuando el trozo de código comentado se encuentra relacionada con otra clase o método, cuyo nombre se indica en nombre.
- @throws nombreClaseExcepción descripción.Cuando un método puede lanzar una excepción se indica así.
- @deprecated descripcion -->Indica que el método ya no se usa y se ha sustituido por otro.
viernes, 28 de noviembre de 2008
JavaDoc
Sirve para explicar qué hace un código y se escriben comenzando por /** y terminando con */ , pudiendo ocupar varias líneas y están destinados a describir, principalmente, clases y métodos. Los comentarios JavaDoc siguen una estructura prefijada,por ejeplo eben incluir unos indicadores especiales, que comienzan siempre por '@' y se suelen colocar al comienzo de línea.