Foros aprenderaprogramar.com

Aprender a programar => Aprender a programar desde cero => Mensaje iniciado por: RaGa en 31 de Marzo 2015, 03:26

Título: Ejercicio CU00680B Cómo documentar proyectos Java con Javadoc @author, @version
Publicado por: RaGa en 31 de Marzo 2015, 03:26

Mi versión del Ejercicio propuesto en la Entrega Nº80. Ejercicio CU00680B.

Clase MiniCalculadoraEjemplo

Código: [Seleccionar]

import java.lang.Math;
import java.util.Scanner;

/** Esta clase tiene métodos que le permiten realizar el ingreso de un valor tipo double a través del teclado por parte del usuario, y realizar dos operaciones matemáticas sobre ese valor.
 * @author: RaGa
 * @version: 01
 * @date:30/03/15
 */

public class MiniCalculadoraEjemplo{
    // Declaración de campos de instancia
    private double valorIngresado;
   
    public MiniCalculadoraEjemplo(){ // Constructor de clase
    }

   
    /** Lee el valor de tipo double que el usuario ingrese por teclado.
     * @return Retorna el valor tipo double ingresado por teclado por el usuario.
     */
    public double leerDouble(){
        Scanner scannerTeclado = new Scanner (System.in);
        double valorTeclado = scannerTeclado.nextDouble();
        String leerIntro = scannerTeclado.nextLine(); // sirve para borrar el intro del buffer
        return valorTeclado;
    }
   
    /** Calcula el valor absoluto del valor que se pasa como argumento.
     * @param Recibe como argumento un número tipo double.
     * @return Se retorna el valor absoluto del argumento de entrada.
     */
    public double calcularValorAbsoluto(double valor){
        return Math.abs(valor);
    }
   
   
    /** Calcula la raíz cuadrada del valor que se pasa como argumento.
     * @param Recibe como argumento un número tipo double.
     * @return Se retorna la raíz cuadrada del argumento de entrada.
     */
    public double calcularRaizCuadrada(double valor){
        return Math.sqrt(Math.abs(valor));
    }
   
} //fin de la clase
Clase TestMiniCalculadoraEjemplo

Código: [Seleccionar]

/**Esta clase sirve para probar la clase MiniCalculadoraEjemplo.
 * @author: RaGa
 * @version: 01
 * @date: 30/03/15
 */

public class TestMiniCalculadoraEjemplo{
    //Declaracion de campos de instancia de la clase
   
   
    public TestMiniCalculadoraEjemplo(){ // Constructor de clase
    }
   
    /**Este método sirve para probar todos los métodos de la clase MiniCalculadoraEjemplo mediante una interfaz con el usuario.
     *
     */
    public static void main(String[] args){
        MiniCalculadoraEjemplo calculadora = new MiniCalculadoraEjemplo();
        double valorIngresado;
       
        System.out.println("\fIngrese un valor numérico por favor:");
        System.out.println("");
        valorIngresado = calculadora.leerDouble();
        System.out.println("El valor absoluto de "+valorIngresado+" es "+calculadora.calcularValorAbsoluto(valorIngresado));
        System.out.println("Y su raíz cuadrada es "+calculadora.calcularRaizCuadrada(valorIngresado));
    }
   
     
} // Fin de la clase
README.TXT

Citar

PROJECT TITLE: Proyecto Documentación.
PURPOSE OF PROJECT: Este proyecto sirve para ejercitar la utilización de la documentación de Java.
VERSION or DATE: 30/03/15
HOW TO START THIS PROJECT: Ejecutar el método main de la Clase TestMiniCalculadoraEjemplo.
AUTHORS: RaGa
USER INSTRUCTIONS: Seguir las instrucciones y mensajes que aparecen por consola.

Título: Re:Ejercicio CU00680B. Ejercicio para documentar proyectos Java con Javadoc.
Publicado por: Marcos Martín en 31 de Marzo 2015, 11:12

Hola RaGa.

Muy buen ejercicio, ya casi lo tienes !!!

Buen trabajo y un saludo.