Solucion Ejercicio CU00680B - Documentar proyectos Java con Javadoc

[jotase1507]

Buenas tardes, subo mi codigo para su revision

Código: [Seleccionar]

/**
 * Clase que realiza operaciones matematicas, como son hallar el Valor Absoluto y la Raiz Cuadrada.
 * @author Juan Calderon
 * @version 21/02/2015 A
 */

public class miniCalculadoraEjemplo {
   
     /**
      * Constructor que no solicita, ni genera datos.
      */
   
    public miniCalculadoraEjemplo ( ) { }
   
    /**
     * Metodo que devuelve el valor absoluto del valor recibido.
     * @param valorRecibido numero del cual se hallara su Valor Absoluto.
     * @return Devuelve el Valor Absoluto del numero recibido.
     */
   
    public double valorAbsoluto(double valorRecibido) {
        double aValorAbsoluto = Math.abs(valorRecibido);
        return aValorAbsoluto;
    }
   
    /**
     * Metodo que devuelve la raiz cuadrada del valor recibido.
     * @param valorRecibido numero del cual se hallara su Raiz Cuadrada.
     * @return Devuelve Raiz Cuadrada del numero recibido.
     */
   
    public double raizCuadrada(double valorRecibido) {
        double aRaizCuadrada = Math.sqrt(valorRecibido);
        return aRaizCuadrada;
    }
}


[toni_apr]

Hola jotase

Tu clase junto con sus comentarios para documentación está perfecta. Bien.

Lo único a destacar es que la convención en Java nos aconseja bautizar la clase MiniCalculadoraEjemplo.
Empezar por mayúscula para distinguirse de objetos, métodos y atributos que empiezan por minúscula.

Cuando creemos proyectos extensos en código, la documentación  es una ayuda inestimable.
Para probarlo crea una clase con main y dentro las dos líneas siguientes:
        miniCalculadoraEjemplo miCalc = new miniCalculadoraEjemplo();
        miCalc.

La segunda línea está incompleta, coloca el cursor después del punto y pulsa [Control + espacio] en la lista que aparece busca uno de los métodos de tu calculadora y observa la información que da.

Saludos

[jotase1507]

Oh si, tienes razon, cree la clase y no me percate de ese detalle. Y logro ver con "miCalc." que las anotaciones introducidas por mi parte en el javadoc se logran visualizar, con eso cualquiera que use la clase puede darse cuenta para que sirve cada metodo creado dentro de esta. Gracias por el aporte.