Diferencia entre revisiones de «Javadoc»
No es una función, sino un código, y el tag @author se usa a nivel de clase, pero no de metodo. |
Sin resumen de edición |
||
(No se muestran 52 ediciones intermedias de 44 usuarios) | |||
Línea 1: | Línea 1: | ||
[[File:Javadoc screenshot.png|thumb]] |
|||
'''Javadoc''' Es una utilidad de [[Sun Microsystems]] para generar [[API]]s en formato [[HTML]] de un documento de código fuente [[Lenguaje de programación Java|Java]]. |
|||
'''Javadoc''' es una utilidad de [[Oracle]] para la generación de documentación de [[API]]s en formato [[HTML]] a partir de código fuente [[Lenguaje de programación Java|Java]]. Javadoc es el estándar de la industria para documentar clases de [[Lenguaje de programación Java|Java]]. La mayoría de los [[Entorno de desarrollo integrado|IDE]]s los generan automáticamente. |
|||
Javadoc también proporciona una API para crear [[doclets]] y [[taglets]], que le permite analizar la estructura de una aplicación Java. Así es como [[JDiff]] puede generar informes de lo que ha cambiado entre dos versiones de una API.<ref>{{cita web|título=Introduction to Javadoc|url=https://www.baeldung.com/javadoc|idioma=Inglés|fechaacceso=5 de junio de 2024}}</ref> |
|||
Javadoc es el estándar de la industria para documentar clases de [[Java]]. La mayoría de los [[IDE]]s los generan automáticamente. |
|||
== Etiquetas Javadoc == |
== Etiquetas Javadoc == |
||
Para generar [[API]] |
Para generar [[Interfaz de programación de aplicaciones|API]] con Javadoc han de usarse etiquetas (tags) de [[HTML]] o ciertas palabras reservadas precedidas por el carácter "@".<br/> |
||
Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/". |
Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/". |
||
A continuación explicamos algunas de las palabras reservadas:<br/> |
|||
A continuación se explican algunas de las palabras reservadas - puede verse una lista completa de las tags con su correspondiente uso en [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#tag oracle.com]. |
|||
⚫ | |||
⚫ | |||
'''''Nota 2:''''' Versión indica desde qué versión de Javadoc es válida.<br/> |
'''''Nota 2:''''' Versión indica desde qué versión de Javadoc es válida.<br/> |
||
:{| class="wikitable" |
:{| class="wikitable" |
||
! Tag |
! Tag !! Descripción !! Uso !! Versión |
||
|- |
|- |
||
|@author |
|@author || Nombre del desarrollador. || nombre_autor || 1.0 |
||
|- |
|- |
||
|@version || Versión del método o clase. || versión || 1.0 |
|||
⚫ | |||
|- |
|- |
||
|@param |
|@param || Definición de un parámetro de un método, es requerido para todos los parámetros del método. || nombre_parametro descripción || 1.0 |
||
|- |
|- |
||
|@return |
|@return || Informa de lo que devuelve el método, no se puede usar en constructores o métodos "void". || descripción || 1.0 |
||
|- |
|- |
||
⚫ | |||
⚫ | |||
|- |
|- |
||
⚫ | |||
⚫ | |||
|- |
|- |
||
|@ |
|@since || Especifica la versión del producto || indicativo numerico || 1.2 |
||
|- |
|||
|@serial || Describe el significado del campo y sus valores aceptables. Otras formas válidas son @serialField y @serialData || campo_descripcion || 1.2 |
|||
|- |
|||
⚫ | |||
|} |
|} |
||
Línea 32: | Línea 39: | ||
Un ejemplo de un Javadoc de un método. |
Un ejemplo de un Javadoc de un método. |
||
<syntaxhighlight lang="Java"> |
|||
<code> |
|||
/** |
/** |
||
* Inserta un título en la clase descripción. |
* Inserta un título en la clase descripción. |
||
Línea 39: | Línea 46: | ||
* |
* |
||
* @param titulo El nuevo título de la descripción. |
* @param titulo El nuevo título de la descripción. |
||
* @throws |
* @throws IllegalArgumentException Si titulo es null, está vacío o contiene sólo espacios. |
||
*/ |
*/ |
||
public void setTitulo (String titulo) throws |
public void setTitulo (String titulo) throws IllegalArgumentException |
||
{ |
{ |
||
if (titulo == null || titulo. |
if (titulo == null || titulo.isBlank()) |
||
{ |
{ |
||
throw new |
throw new IllegalArgumentException("El título no puede ser nulo o vacío"); |
||
} |
} |
||
else |
else |
||
Línea 52: | Línea 60: | ||
} |
} |
||
} |
} |
||
</syntaxhighlight> |
|||
</code> |
|||
== Referencias == |
|||
{{Listaref}} |
|||
== Enlaces externos == |
== Enlaces externos == |
||
* [http://java.sun.com/j2se |
* [http://java.sun.com/j2se/javadoc/ Página principal de Javadoc - incluye enlaces a documentación de referencia y a tutoriales ] |
||
* [http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html Documentación de uso de Javadoc - describe la herramienta javadoc e incluye ejemplos de uso y etiquetas válidas para Windows] |
|||
* [https://web.archive.org/web/20170424184732/http://myjavadoc.net/ Buscador de Javadocs online - permite encontrar la documentación Javadoc de una clase a partir de su nombre] |
|||
⚫ | |||
[[Categoría:Java]] |
|||
{{Control de autoridades}} |
|||
[[cs:Javadoc]] |
|||
⚫ | |||
[[de:Javadoc]] |
|||
[[Categoría:Generadores de documentación]] |
|||
[[en:Javadoc]] |
|||
[[fr:Javadoc]] |
|||
[[it:Javadoc]] |
|||
[[ja:Javadoc]] |
|||
[[nl:Javadoc]] |
|||
[[no:Javadoc]] |
|||
[[pt:Javadoc]] |
|||
[[ru:Javadoc]] |
Revisión actual - 07:05 5 jun 2024
Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente.
Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API.[1]
Etiquetas Javadoc
[editar]Para generar API con Javadoc han de usarse etiquetas (tags) de HTML o ciertas palabras reservadas precedidas por el carácter "@".
Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/".
A continuación se explican algunas de las palabras reservadas - puede verse una lista completa de las tags con su correspondiente uso en oracle.com.
Nota 1: En uso explica la semántica del texto tras el tag.
Nota 2: Versión indica desde qué versión de Javadoc es válida.
Tag Descripción Uso Versión @author Nombre del desarrollador. nombre_autor 1.0 @version Versión del método o clase. versión 1.0 @param Definición de un parámetro de un método, es requerido para todos los parámetros del método. nombre_parametro descripción 1.0 @return Informa de lo que devuelve el método, no se puede usar en constructores o métodos "void". descripción 1.0 @throws Excepción lanzada por el método, posee un sinónimo de nombre @exception nombre_clase descripción 1.2 @see Asocia con otro método o clase. referencia (#método(); clase#método(); paquete.clase; paquete.clase#método()). 1.0 @since Especifica la versión del producto indicativo numerico 1.2 @serial Describe el significado del campo y sus valores aceptables. Otras formas válidas son @serialField y @serialData campo_descripcion 1.2 @deprecated Indica que el método o clase es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores. descripción 1.0
Ejemplo
[editar]Un ejemplo de un Javadoc de un método.
/**
* Inserta un título en la clase descripción.
* Al ser el título obligatorio, si es nulo o vacío se lanzará
* una excepción.
*
* @param titulo El nuevo título de la descripción.
* @throws IllegalArgumentException Si titulo es null, está vacío o contiene sólo espacios.
*/
public void setTitulo (String titulo) throws IllegalArgumentException
{
if (titulo == null || titulo.isBlank())
{
throw new IllegalArgumentException("El título no puede ser nulo o vacío");
}
else
{
this.titulo = titulo;
}
}
Referencias
[editar]- ↑ «Introduction to Javadoc» (en inglés). Consultado el 5 de junio de 2024.
Enlaces externos
[editar]- Página principal de Javadoc - incluye enlaces a documentación de referencia y a tutoriales
- Documentación de uso de Javadoc - describe la herramienta javadoc e incluye ejemplos de uso y etiquetas válidas para Windows
- Buscador de Javadocs online - permite encontrar la documentación Javadoc de una clase a partir de su nombre