Ejercicio! entrega CU00680B documentación clases con javadoc

[Jorge lopez]

 Documentando proyectos con javadoc.
public class MiniCalculadoraEjemplo

Código: [Seleccionar]

import java.lang.Math;
 /**Esta clase realiza dos operaciones matemáticas apoyada en métodos de la  clase Math del paquete lang del api de java.
    @author SniperOfElite
    @version 1.0
    */
public class MiniCalculadoraEjemplo
{
     /**Constructor general de la clase
       "constructor sin inicialisaciones"*/
     public MiniCalculadoraEjemplo()
     {
         //nada que declarar
     }
     //el método abs de la clase Math del paquete lang del api de java, devuelve el valor absoluto de un numero, ya sea un valor tipo int, double, float o long.
     /**Método de tipo función, recibe un parámetro, realiza una operación matemática y retorna un valor.
       @param valorInAnsoluto parámetro de tipo primitivo double.
       @return retorna un tipo primitivo double como el valor absoluto del parametro valorInAbsoluto de tipo primitivo double.
       @see http://docs.oracle.com/javase/6/docs/api/java/lang/Math.html#abs(double)
       */
     public double unValorAbsoluto(double valorInAbsoluto)
     {
       return Math.abs(valorInAbsoluto);
     }   
     //el método sqrt de la clase Math del paquete lang del api de java, devuelve la raíz cuadrada de un valor tipo double.
     /**Método de tipo función, recibe un parámetro, realiza una operación matemática y retorna un valor.
       @param valorACalcular parámetro de tipo primitivo double.
       @return retorna un tipo primitivo double como el valor de la raíz cuadrada del parámetro valorACalcular de tipo primitivo double.
       @see http://docs.oracle.com/javase/6/docs/api/java/lang/Math.html#sqrt(double)
       */     
     public double dimeRaizCuadrada(double valorACalcular)
     {
       return Math.sqrt(valorACalcular);
     }
}

[Mastermind]

Lo veo bien pero has repetido la misma descripción en dos métodos:

Método de tipo función, recibe un parámetro, realiza una operación matemática y retorna un valor.

Esto realmente no dice lo que hace el método, si te fijas en cómo se describen los métodos en la documentación del api, se describe lo que hace el método, por ejemplo

sqrt(double a)
          Returns the correctly rounded positive square root of a double value.

Por eso deberías incluir en cada método una descripción que refleje bien lo que hace como:

Método de tipo función, recibe un parámetro double, y devuelve el valor absoluto de dicho parámetro.

Con esto podemos saber lo que hace el método, de la otra forma realmente no lo sabemos ( a no ser que leamos el resto de líneas, pero eso no tiene por qué ser así)

Saludos

[Jorge lopez]

 Interesante correcion, lo tomare en cuenta a la hora de volver a documentar métodos.
Saludos  Mastermind.