Ejemplo de documentación de una clase

Como no hay mejor maestro que Don Ejemplo (o eso dicen), os pongo un ejemplo de como se debe documentar una clase, con las recomendaciones ya explicadas. Ejemplo package com.elorduy.gorka.ejercicios; /* * Clase Grupo.java * Ejemplo de documentación de código * Fecha: 28-12-2016 * Gorka Elorduy García */ /** * La clase Grupo permite disponer…… Continúa leyendo Ejemplo de documentación de una clase

Orden de las etiquetas

El orden de las etiquetas debe ser el siguiente: @author: En clases e interfaces. Se pueden poner varios. En este caso, resulta apropiado hacerlo en orden cronológico @version: En clases y en interfaces @param: En métodos y constructores. Se ponen tantos como argumentos tenga el constructor o el método. Deberían aparecer en el mismo orden…… Continúa leyendo Orden de las etiquetas

Uso de las etiquetas

Bueno, ya estoy de vuelta. Espero que hayáis pasado unas fiestas navideñas magníficas, en compañía de vuestros seres queridos. Y ahora, volvamos con Java. Voy a describir el uso de las etiquetas de documentación más habituales. @author texto con el nombre El texto después de la etiqueta no tiene que tener ningún formato especial. Se…… Continúa leyendo Uso de las etiquetas

Etiquetas y posición

No todas las etiquetas se pueden utilizar en cualquier comentario de documentación. Hay etiquetas que no tienen sentido delante de un constructor de una clase, como, por ejemplo @param, y tampoco para describir un atributo. Existen dos tipos de etiquetas de documentación: Etiquetas de bloque: Son las etiquetas que sólo se pueden incluir en el…… Continúa leyendo Etiquetas y posición

Porqué hay que documentar

En Java, la documentación del código es fundamental. Resulta evidente en cuanto se consulta la documentación de las clases que proporciona en los paquetes que distribuye Oracle. Toda la documentación se ha generado utilizando una herramienta, llamada javadoc. También se podrá hacer lo mismo con todos los programas. Es muy recomendable (casi obligatorio) que el…… Continúa leyendo Porqué hay que documentar