Foros aprenderaprogramar.com

Aprender a programar => Aprender a programar desde cero => Mensaje iniciado por: LuisM en 27 de Julio 2017, 21:35

Título: Documentar proyectos Java con Javadoc param return author version etc CU00680B
Publicado por: LuisM en 27 de Julio 2017, 21:35
Hola a todos !! Paso a dejar el ejercicio propuesto en la clase CU00680B del manual de programación Java como si estuviera en primero. Desde ya muchas gracias. Saludos

Luis

EJERCICIO

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.

Código: [Seleccionar]
import java.lang.Math; //Importamos la clase Math de la biblioteca del API Java
/**
 * @author Luis
 * @version 1.0
 * Entrega nº80 del curso "Aprender programación Java desde cero".
 */
//Clase que permite elevar un número m a otro número n y obtener un resultado
public class miniCalculadoraEjemplo {
    /**
     * El constructor es sin asignación de parametros.
     */
    public miniCalculadoraEjemplo () { //Nada que declarar
    }

    /**
     * Metodo que devuelve el valor absoluto de m
     * @param m número del tipo double
     */
    public double valorAbsoluto(double m) {
        return Math.abs(m);
    } //Cierre del método
    /**
     * Metodo que devuelve la raiz cuadrada de m
     * @param m número del tipo double POSITIVO
     */
    public double raizCuadrada(double m) {
        return Math.sqrt(m);
    }
} //Cierre de la clase
Título: Re:Documentar proyectos Java con Javadoc param return author version etc CU00680B
Publicado por: Alex Rodríguez en 16 de Agosto 2017, 18:36
Hola LuisM, te ha faltado incluir los @return en los métodos que retornan algo, eso deberías corregirlo.

Puedes orientarte viendo este enlace: https://www.aprenderaprogramar.com/foros/index.php?topic=2347.0

Saludos
Título: Re:Documentar proyectos Java con Javadoc param return author version etc CU00680B
Publicado por: LuisM en 16 de Agosto 2017, 21:37
Muchas gracias Alex !! Pongo abajo el código corregido.
Saludos
Luis
Código: [Seleccionar]
import java.lang.Math; //Importamos la clase Math de la biblioteca del API Java
/**
 * @author Luis
 * @version 1.0
 * Entrega nº80 del curso "Aprender programación Java desde cero".
 */
//Clase que permite elevar un número m a otro número n y obtener un resultado
public class miniCalculadoraEjemplo {
    /**
     * el constructor es sin asignacion de parámetros
     */
    public miniCalculadoraEjemplo () { //Nada que declarar
    }

    /**
     * Metodo que devuelve el valor absoluto
     * @param m número del tipo double
     * @return el valor absoluto de m (double)
     */
    public double valorAbsoluto(double m) {
        return Math.abs(m);
    } //Cierre del método
    /**
     * Metodo que devuelve la raiz cuadrada
     * @param m número del tipo double POSITIVO
     * @return la raiz cuadrada de m (double)
     */
    public double raizCuadrada(double m) {
        return Math.sqrt(m);
    }
} //Cierre de la clase