Documentación en Java#

Logo Java

Sintáxis básica de Java

Javadoc#

Crear documentación#

En un archivo java se crea la documentaación con comentarios:

 1package com.mycompany.videoconsolas;
 2
 3/**
 4* Prueba de documentación Javadoc
 5*
 6* @author Guillermo Granados Gómez
 7* @version 1.0
 8*/
 9
10public class Consola {
11    /**
12    * Marca de Consola
13    */
14    public String marca;
15    /**
16    * Modelo de Consola
17    */
18    public String modelo;
19    /**
20    * Año de lanzamiento de Consola
21    */
22    public int lanzamiento;
23
24    /**
25    * Constructor padre, lanza un mensaje cuando se crea el objeto
26    */
27    private Consola(){
28        System.out.println("Se ha creado el objeto consola");
29    }
30
31    /**
32    * Constructor hijo, carga los parámetros en los atributos de la clase
33    */
34    public Consola(String marca, String modelo, int lanzamiento){
35        this();
36        this.marca = marca;
37        this.modelo = modelo;
38        this.lanzamiento = lanzamiento;
39    }
40
41    /**
42    * Muestra informaación de un objeto consola.
43    */
44    public void info(){
45        System.out.println("La consola " + marca + " " + modelo + " fue lanzada en " + lanzamiento);
46    }
47
48    /**
49    * Muestra el nombre completo del dispositivo.
50    */
51    public String nombre(){
52        return marca + " " + modelo;
53    }
54
55    /**
56    * Recibe un nombre e indica de quién es la consola.
57    */
58    public String propietario(String nombre){
59        return "La consola " + marca + " " + modelo + " es de " + nombre;
60    }
61
62}

Compilar y crear javadoc#

  1. Hacemos click derecho en el nombre del proyecto y seleccionar la opción Click and build

  2. Nuevamente click derecho en el nombre del proyecto y seleccionar Generate Javadoc

  3. El archivo html se genera dentro de la ruta nombreProyecto/target/site/apidocs/allpackages-index.html

En la carpeta apidocs tenemos toda la documentación estructurada de todas las clases.