Java documentar una clase con Javadoc y visualizar documentación CU00680B

[ronal.d87]

Hola a todos, he aqui el desarrollo del ejercicio planteado.

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]

/*
 *
 */

package ejemplo;

/**
 * Clase que calcula el valor absoluto y la raiz cuadrada de un numero
 * @author Ronald Mosquera
 * @version: 1.3
 */
public class MiniCalculadoraEjemplo {
    /**
     * Constructor general sin parametros
     */
    public MiniCalculadoraEjemplo(){
        //constructor vacio
    }
    /**
     * Metodo que devuelve un valor absouluto
     * @param valorAbsoluto El parametro valorAsoluto calcula
     * el valorAsoluto de un numero
     * @return El valor absorAsoluto de un numero
     */
    public double valorAbsoluto(double valorAbsoluto){
        return Math.abs(valorAbsoluto);
    }
    /**
     * metodo que devuelve una raiz cuadrada
     * @param raizCuadrada El parametro raizCuadrada calcula
     * la raiz cuadrada de un numero
     * @return El valor de la raiz cuadrada de un numero
     */
    public double raizCuadrada(double raizCuadrada){
        return Math.sqrt(raizCuadrada);
    }

}


[RaGa]

Hola Ronald:

Tu ejercicio está muy bien! Has utilizado muy bien los tags y los comentarios.

Una recomendación solamente para hacerte.Rebautizaría el nombre de los métodos raizCuadrada y valorAbsoluto por calculaRaizCuadrada y calculaValorAbsoluto. Creo que sería más concordante de esa manera ya que es lo que el método hace. Este tipo de nombres de métodos está más en sintonía con lo que hace el método. Recuerda otros nombres de métodos visto anteriormente: dimeTipoMotor, setNombre (que traducido sería estableceNombre), etc.

De la misma manera, a los parámetros de esos métodos los rebautizaría como valorNumerico. Ya que nombres como valorAbsoluto o raizCuadrada podria dar lugar a una malinterpretación al pensar que dichos parámetro ya son el valor absoluto o la raiz cuadrada, cuando en realidad estos parámetros son los valores sobre los que queremos trabajar dentro del método.

Transcribo a manera de sugerencia cómo podrían quedar estos dos métodos, haciendo además una pequeña modificación sobre los comentarios de la etiqueta @param

Código: [Seleccionar]

    /**
     * Metodo que devuelve un valor absouluto
     * @param valorNumerico El parametro valorNumerico corresponde
     * al número sobre el que se quiere calcular el valor absoluto.
     * @return El valor absorAsoluto de un numero
     */
    public double calculaValorAbsoluto(double valorNumerico){
        return Math.abs(valorNumerico);
    }
    /**
     * metodo que devuelve una raiz cuadrada
     * @param valorNumerico El parametro valorNumerico corresponde
     * al número sobre el que se quiere calcular la raíz cuadrada.
     * @return El valor de la raiz cuadrada de un numero
     */
    public double valorRaizCuadrada(double valorNumerico){
        return Math.sqrt(valorNumerico);
    }

[ronal.d87]

Gracias, por la recomendacion. he aqui la correccion

Código: [Seleccionar]

/*
 *
 */

package ejemplo;

/**
 * Clase que calcula el valor absoluto y la raiz cuadrada de un numero
 * @author Ronald Mosquera
 * @version: 1.3
 */
public class MiniCalculadoraEjemplo {
    /**
     * Constructor general sin parametros
     */
    public MiniCalculadoraEjemplo(){
        //constructor vacio
    }
    /**
     * Metodo que devuelve un valor absouluto
     * @param valorAbsoluto El parametro valorAsoluto calcula
     * el valorAsoluto de un numero
     * @return El valor absorAsoluto de un numero
     */
    public double calcularValorAbsoluto(double valorAbsoluto){
        return Math.abs(valorAbsoluto);
    }
    /**
     * metodo que devuelve una raiz cuadrada
     * @param raizCuadrada El parametro calcularRaizCuadrada calcula
 la raiz cuadrada de un numero
     * @return El valor de la raiz cuadrada de un numero
     */
    public double calcularRaizCuadrada(double raizCuadrada){
        return Math.sqrt(raizCuadrada);
    }

}


[RaGa]

Hola Ronald:

Está muy bien. Creo acertada esa elección de nombres para dichos métodos.
Igualmente considera para los ejercicios siguientes la recomendación que te hacía respecto de los nombres que elegimos para los parámetros de los métodos.

A seguir adelante entonces!