Javadoc

Utilitario para generación automática de

documentación HTML a partir de código
fuente Java
Javadoc Parte del kit de desarrollo de software Java
SDK
Mario Medina C. Información se define como comentarios
mariomedina@udec.cl especiales en el código
Android Studio incluye soporte para
Javadoc

Comentarios javadoc Comentarios javadoc

Deben incluirse justo antes del código
asociado
Comentario debe incluir una breve
descripción
Opcionalmente, le sigue una descripción mas
detallada
Luego, se incluyen diferentes tags de
metadatos, que deben ir en un orden
específico
Algunos tags de javadoc son:
@author: autor del código
@version: número de versión
@param: parámetros de un método
@return: valores retornados por un método
@throws: excepciones generadas
@see: enlaces a otros ítems relacionados
@since: cuándo se introduce este código
@deprecated: describe ítem obsoleto

Ejemplos javadoc Ejemplos javadoc

/** /**
* Actividad para cargar recursos de layout * Metodo para sumar dos Integer
* *
* Esta actividad muestra diferentes * @param a primer Integer
* recursos de layout para uso en un * @param b segundo Integer
* tutorial de Android * @return la suma de a y b
* * @author Mario Medina
* @author Mario Medina * @version 2018.03.24
* @version 2018.03.24
* @since 1.0
* @since 1.0
*/
*/
public class LayoutActivity extends Activity { public Integer sumaIntegers(Integer a,
Integer b){
return (a + b);
}

© 2018 Mario Medina C. 1

 Javadoc en Android Studio
Acceder al menú Tools
Seleccionar opción Generate Javadoc…
Escoger opciones de generación
Generar documentación para todo el
proyecto, todas las clases, sólo clases públicas,
etc.
Incluir documentación para bibliotecas del
sistema
Directorio destino para archivos .html

© 2018 Mario Medina C. 2