Foros aprenderaprogramar.com

Aprender a programar => Aprender a programar desde cero => Mensaje iniciado por: Dan_SB en 13 de Abril 2015, 06:21

Título: Generar documentación java automáticamente Javadoc NetBeans Ejercicio CU00680B#
Publicado por: Dan_SB en 13 de Abril 2015, 06:21
Buenas noches!!

Resuelvo el ejercicio del capitulo 80° del curso, su enunciado es así:

Crea una clase denominada miniCalculadoraEjemplo que tenga dos métodos (basados en el uso de métodos de la clase Math): un método valorAbsoluto que recibe un número de tipo double y devuelva su valor absoluto, y otro método raizCuadrada que reciba un número de tipo double y devuelva su raíz cuadrada. Documenta esta clase conforme a los estándares JavaDoc y comprueba cómo se visualiza la documentación.

Esta clase ya la tenia guardada, solo era colocarle los comentarios y demas!!! La clase miniCalculadora:

Código: [Seleccionar]
package miniCalculator;
/**
 *Calcula el valorAbsoluto y raiz cuadrada de un valor.
 * @version 1.00.0
 * @author Daniels
 */
public class miniCalculadora {
    /**
     * Constructor de la clase miniCalculadora
     */
    public miniCalculadora(){}
    /**
     * Calcula el valor absoluto de un numero.
     * @param numeroAbs: Recibe numero para sacar valor absoluto.
     * @return: Devuelve valor absoluto.
     */
    public double valorAbsoluto(double numeroAbs){
        return Math.abs(numeroAbs);
    }
    /**
     * Calcula la raiz cuadrada de un numero
     * @param num: Recibe numero para sacar raiz cuadrada.
     * @return: Devuelve la raiz cuadrada del numero recibido.
     */
    public double raizCuadrada(double num){
        return Math.sqrt(num);
    }
}

Y pues, así se ve si generas el javadoc:

(http://i.imgur.com/Jn03Ihm.png)

Super nuevo para mi, no conocía esto! con razón cada vez que creo una clase en netbeans, me genera un código en comentarios con el patron de asteriscos y slash con @author... ya veo que se trataba de comentarios para el javadoc...

Muchas gracias de nuevo y saludos!
Título: Re:Ejercicio CU00680B Generar documentación java automáticamente (Javadoc) NetBeans
Publicado por: Mario R. Rancel en 14 de Abril 2015, 08:37
Hola Dan! Todo correcto. Generar clases bien documentadas es un aspecto importante de la programación profesional Java, con esto ya tienes por lo menos una idea general o punto de partida sobre aspectos de documentación de código Java. A continuar. Saludos.