---
# System prepended metadata

title: phpDocumentor Ubuntu 22.04

---

# Instalación de phpDocumentor en Ubuntu 22.04 LTS:

El primer paso siempre es el mismo; actualizar los repositorios: 
```bash=
sudo apt update
```

Ahora instalaremos los paquetes de Composer y phpDocumentor: 
```bash=
sudo apt install composer
composer global require phpdocumentor/phpdocumentor
```

Ahora tendremos que poner la siguiente línea en el archivo bashrc: 
```bash=
gedit ~/.bashrc

export PATH="$PATH:$HOME/.composer/vendor/bin"
```
Guardaremos y cerraremos el archivo. Ahora tendremos que re-ejecutar el servicio de bashrc con el siguiente comando: 
```bash=
source ~/.bashrc
```
Ahora verificaremosm la instalación con el siguiente comando: 

```bash=
phpdoc --version
```

## Plantillsa de código en Javadoc.

Javadoc es una herramienta de generación de documentación en Java, y utiliza comentarios especiales en el código fuente para generar automáticamente documentación legible para humanos. Las plantillas de código en Javadoc se utilizan para describir diferentes partes del código. Los principales componentes de las plantillas de código en Javadoc son:

1. Comentarios de Documentación:

Los comentarios que comienzan con /** y terminan con */ son interpretados por Javadoc como documentación.
Pueden incluir etiquetas como @param, @return, @throws, etc., para describir los parámetros, el valor de retorno y las excepciones lanzadas por un método.

```java=
/**
 * Este es un ejemplo de comentario de documentación en Javadoc.
 * @param parametro Descripción del parámetro.
 * @return Descripción del valor de retorno.
 * @throws ExcepcionTipo Descripción de la excepción.
 */
public int ejemploMetodo(String parametro) throws ExcepcionTipo {
    // Código del método
}

```
2. Etiquetas Javadoc:

Las etiquetas Javadoc comienzan con el símbolo @ seguido de un nombre de etiqueta y su descripción.
Ejemplos de etiquetas comunes son @param para describir parámetros, @return para el valor de retorno y @throws para describir excepciones.
```java=
/**
 * @param nombre Nombre del usuario.
 * @return Saludo personalizado.
 */
public String saludar(String nombre) {
    return "Hola, " + nombre + "!";
}

```

Las plantillas de código en Javadoc permiten generar documentación fácilmente desde el código fuente, mejorando la legibilidad y comprensión del código. Es importante seguir las convenciones y prácticas recomendadas al escribir comentarios de documentación para asegurar una generación de documentación coherente y útil.