Java.Documentar clae con Javadoc errores habituales buenas prácticas CU00680B

[dferna]

Buenas 

Aquí dejo la resolución al ejercicio CU00680B del taller de programación Java con IDE BlueJ sobre el tema de la documentación con Javadoc sobre la aplicación de una mini calculadora.

Clase de test

Código: [Seleccionar]

package aplicacion;

import calculadora.MiniCalculadora;

/**
 * Clase encargada de realizar la prueba de la clase MiniCalculadora
 * @author David
 *
 */
public class Test {

/**
* Método main donde comienza la ejecución del programa
* @param args
*/
public static void main(String[] args) {

MiniCalculadora calculadora = new MiniCalculadora();

double numero1 = -3;
double numero2 = 25;
double valorAbsoluto = calculadora.valorAbsoluto(numero1);
double raizCuadrada = calculadora.raizCuadrada(numero2);

System.out.println("El valor absoluto de "+numero1+" es: "+valorAbsoluto);
System.out.println("La raiz cuadrada de "+numero2+" es: "+raizCuadrada);
}

}

Clase MiniCalculadora con los métodos de la lógica de la aplicación.

Código: [Seleccionar]

package calculadora;

/**
 * Clase que contiene los metodos de la lógica de la calculadora
 * @author David
 *
 */
public class MiniCalculadora {

/**
* Método encargado de convertir el número que recibe por parametros a su valor absoluto
* @param numero
* @return valorAbsoluto
*/
public double valorAbsoluto(double numero){

double valorAbsoluto = Math.abs(numero);
return valorAbsoluto;
}

/**
* Método encargado de realizarle la raiz cuadrada al número que recibe por parametros
* @param numero
* @return raizCuadrada
*/
public double raizCuadrada(double numero){

double raizCuadrada = Math.sqrt(numero);
return raizCuadrada;
}
}

Ejecución del programa

El valor absoluto de -3.0 es: 3.0
La raiz cuadrada de 25.0 es: 5.0

Saludos 

[pedro,,]

Buenas.

Los comentarios que usaste están bien, aunque también estaría bien que describieses en que consiste el la variable que se devuelve en los dos métodos.

Sobre los nombres que usaste en métodos y variables, sería aconsejable que los nombres de los métodos no coincidiesen con los de las variables para evitar posibles errores, a los métodos les podrías añadir el prefijo get.

getRaizCuadrada(...)

Saludos.