No tienes acceso a esta clase

隆Contin煤a aprendiendo! 脷nete y comienza a potenciar tu carrera

Aprende Ingl茅s, Programaci贸n, AI, Ciberseguridad y m谩s a precio especial.

Antes: $249

Currency
$209
Suscr铆bete

Termina en:

2 D铆as
2 Hrs
13 Min
50 Seg
Curso de Introducci贸n a Java SE

Curso de Introducci贸n a Java SE

Anah铆 Salgado D铆az de la Vega

Anah铆 Salgado D铆az de la Vega

Javadoc en funciones

29/39
Recursos

Vamos a documentar la funci贸n convertToDolar. Recuerda que esta funci贸n devuelve un n煤mero double y recibe dos argumentos: quantity (de tipo double) y currency (de tipo String):

/**
 * Descripci贸n general de nuestra funci贸n.
 * 
 * @param quantity Descripci贸n del par谩metro quanity.
 * @param currency Descripci贸n del par谩metro currency (MXN o COP).
 * @return Descripci贸n del valor que devolvemos en esta funci贸n.
 * */

Para que el IDE muestre la descripci贸n y documentaci贸n de las funciones debemos entrar a IntelliJ IDEA > Preferences > Editor > General > Code Complettion y habilitar la opci贸n de Show the documentarion popup.

隆No olvides documentar todas las funciones que has escrito hasta ahora!

Aportes 141

Preguntas 20

Ordenar por:

驴Quieres ver m谩s aportes, preguntas y respuestas de la comunidad?

Para encontrar el Toollkit en Windows: File-Settings-Editor-General-CodeCompletion - Show the Documentation Popup in [1000] ms

Para activar la visibilidad de la documentaci贸n en Windows:
.
File > Settings > Editor > General > Code Completion y pasas a activar la opci贸n "Show the documentation popup in 1000 ms" y por ultimo le das a OK
.
隆Saludos!

驴POR QU脡 NADIE ME ENSE脩脫 ESTO ANTES? PUDE HABER PASADO LA UNI M脕S R脕PIDO JAJAJA TE AMO PLATZI muchas gracias @anncode 鉂わ笍

![](

En el IDE si escribes /** y das ENTER, autom谩ticamente la herramienta completa el comentario de documentaci贸n con los par谩metros y si tiene return tambi茅n lo coloca. Quedar铆a as铆, por ejemplo y se procede a completar manualmente.

/**
*
* @param r
* @return
*/

Lamentablemente esto no ense帽an en la U solo Platzi te brinda lo mejor Gracias Platzi !!!

Para los que usan windows
Clic File/Settings/Editor/CodeCompletion
Clic "Show the documentation popuo in 1000ms"
Y darle OK
Espero te haya servido.

Y as铆 me quedaron los comentarios con Javadoc:

Definitivamente es una funci贸n de much铆sima utilidad, la usar茅 siempre y sin excepci贸n para hacer la costumbre.

Para abrir la documentacion de una clase o funci贸n en una ventana externa como lo hizo la profe, mantienen el cursor encima de la clase que quieren ver y dejan presionado ctrl, despu茅s solo dan click y listo.

Otra manera de visualizar la documentaci贸n es posicionarse en el nombre de la funci贸n y presionan CTRL + Q

A muchos les parecera que no es necesario, que yo lo programe y yo se lo que hice, pero creeme dentro de tan solo una semana que no toques ese codigo y te toque volver a este se te habra olvidado todo. Y si eso te pasa a ti imaginate a tus compa帽eros, comentar y documentar el codigo facilita mucho el trabajo ademas que te permite optimizarlo a futuro o generar un estandar que haga que el flujo de trabajo sea lo mas optimo posible.

En windows para acceder a las configuraciones para activar los comentarios es: File y luego settings.

Puede que a alguien del 2022 le sirva este aporte, una forma sencilla que descubr铆 en el IDE que se utiliza en este curso es d谩ndole clic derecho sobre la funci贸n que quieras comentar y mostrar谩 la opci贸n de 鈥淪how Context Actions鈥, despu茅s abrir谩 otro submen煤 donde da la opci贸n de 鈥淎dd Javadoc鈥 y as铆 de sencillo te crear谩 un espacio para comentar tu funci贸n, lo mismo que hace la teacher Anah铆.

(Windows 10) Para visualizar la documentacion al poner el cursor sobre el nombre del m茅todo hay que activarlo yendo a File > Settings >馃斀Editor >馃斀General > CodeCompletion, activar la opci贸n "鉁匰how the Documentation Popup in [1000] ms " luego presionar el bot贸n a Apply y OK.

public class CurrencyConverter {
    public static void main(String[] args) {
        double usd = 0;

        usd = converToDolar(200, "MXN");
        System.out.println("Pesos MXN a USD: $" + usd);

        usd = converToDolar(20000, "ARS");
        System.out.println("Pesos ARS a USD: $" + usd);
    }
    /**
     * Descripci贸n: Funci贸n que especificando su moneda convierte una cantidad de dinero a d贸lares.
     *
     * @param quantity Cantidad de dinero
     * @param currency Tipo de Moneda: solo acepta MXN, COP y ARS
     * @return quantity Devuelve la cantidad actualizada en USD
     * */
    public static double converToDolar(double quantity, String currency) {
        switch (currency) {
            case "MXN":
                quantity = quantity * 0.050 ;
                break;
            case "COP":
                quantity = quantity * 0.00023;
                break;
            case "ARS":
                quantity = quantity * 0.0071;
                break;
        }
        return quantity;
    }
}

Listo Amo IntelliJ

En IntelliJ (Windows) podemos presionar en el teclado **ALT + CTRL + Q ** y convierte los comentarios de JavaDoc de esto:

A esto:

No s茅 si a alguien le ayude porque el curso ya es un poco viejo pero para ver el Javadoc en VSCode solo debes poner el cursor sobre el nombre de la funci贸n y ya te sale, no es necesario hacer nada m谩s XD.

InteliJ Idea es genial pero siempre es bueno no depender solamente del ide porque si por a o b este llega a faltar basicamente ya no sabriamos como programar

__Javadoc en funciones__馃

en intelliJ pueden seleccionar sus funciones y presionar Ctrl + q para ver sus documentaciones

A partir de ahora, aunque puede costar m谩s, har茅 eso, gracias Anah铆, a documentar se ha dicho, 驴Algunos otros consejos m谩s que me puedan dar a la hora de documentar?

public class MathematicOperations {
    public static void main(String[] args) {
        double x = 2.1;
        double y = 3;

        //Area de un circulo
        //pi * r2
        double area = circleArea(y);
        System.out.println(area);

        //Area de una esfera
        //4*PI*r2
        sphereArea(y);

        //Volumen de una esfera
        //(4/3)*pi * r3
        sphereVolume(y);



        System.out.println("Pesos a dolares :  " + convertToDolar(1000, "COP"));
    }


    /**
     * Funci贸n para el area de un circulo especificando el radio del mismo
     * @param r Es el radio qe se usa para la ecuacion
     * @return devuelve el area del circulo directamente
    * */
    public static double circleArea(double r) {
        return Math.PI * Math.pow(r, 2);
    }


    /**
     * Funcion para encontrar el area de una esfera
     * @param r El radio del esfera
     * @return devuelve el area de la esfera
     * */
    public static double sphereArea(double r) {
        return 4 * Math.PI * Math.pow(r, 2);
    }

    /**
     * Funcion para encontrar el volumen de una esfera
     * @param r El radio de la esfera
     * @return devuelve el volumen de la misma
     * */
    public static double sphereVolume(double r) {
        return (4 / 3) * Math.PI * Math.pow(r, 3);
    }

    /**
     *Funci贸n que especificando el tipo de moneda lo convierte una cantidad de dinero a d贸lares
     * @param quantity cantidad de dinero
     * @param currency Tipo de moneda: solo se acepta MXN o COP
     * @return quantity Devuelve la cantidad en dolares
     * */
    public static double convertToDolar(double quantity, String currency) {
        switch (currency) {
            case "MXN":
                quantity = quantity * 0.052;
                break;
            case "COP":
                quantity = quantity * 0.00031;
                break;
        }
        return quantity;
    }
}

Para poder generar el HTML daremos a las siguientes opciones:
Tools>Generate JavaDoc> Damos a la opci贸n Whole projects para extraer todo la documentaci贸n del proyecto o tambi茅n solo podemos generar el de la clase en donde nos encontremos > Seleccionamos la ubicaci贸n del archivo y Accesibilidad > Generate

馃惐鈥嶐煉 Podemos utilizar CTRL + Q para hacer una b煤squeda r谩pida de documentaci贸n.

![](

Java facilitando la vida.

para los que tengamos windows y no encontramos el ToolKit que la profesora menciona, debe hacerse lo siguiente: File-Settings

Para acceder a la clase y ver su documentaci贸n desde windows es con Ctrl +N y en mac Comand + O

woa me encanto! no sabia que se podia hacer eso

Activar en el IDE IntelliJ la documentacion se muestre en el tooltip

Hola a todos 馃, Les comparto un tipo que descubr铆: Para los comentarios de la documentaci贸n, **IntelliJ IDEA** proporciona un completado que est谩 activado por defecto. Podemos escribir **/\*\*** antes de una declaraci贸n y pulsar **Enter**. El IDE autocompleta el comentario de documentaci贸n por nosotros. Aqu铆 dejo un link de referencia: <https://www.jetbrains.com/help/idea/javadocs.html#auto-comment> Espero sea util. 馃

Para encontrar el Toollkit en Windows: File-Settings-Editor-General-CodeCompletion - Show the Documentation Popup in [1000] ms

Me gusta mucho la forma que tiene Java para documentar c贸digo y que quede como descripci贸n al seleccionar o pasar sobre las funciones, es bastante 煤til y gu铆a bastante

Me encant贸!!! Siempre escuch茅 de java docs y nunca entend铆 eso c贸mo se com铆a

Si estas usando Visual Studio Code puedes suar esta extenci贸n llamada Javadoc Tools

En Visual Studio Code van a >configuracion y buscan >java code generation y activan esto:
馃憞

para activarlo en Netbeans 8.2

En el editor de c贸digo fuente seleccione la clase que desea consultar en los Javadocs y presione ALT+F1 o haga clic derecho y elija la opci贸n Show Javadoc del men煤 contextual.

@author - El nombre del autor del proyecto por ejemplo pepito 馃槂
@version - La versi贸n del proyecto
@see - A帽ade una referencia a una clase, m茅todo o enlace web
@param - Nombre de par谩metro utilizado en un m茅todo incluido su significado
@return - El resultado de un m茅todo incluido su descripci贸n
@exception - Nombre de la excepci贸n mas una descripci贸n
@throws - Nombre de la excepci贸n mas una descripci贸n
@deprecated - A帽ade una alerta al usuario de que el m茅todo que sigue a continuaci贸n ya no debe usarse y que ser谩 eliminado en versiones posteriores.

En Intellij Idea, si te ubicas arriba de la funci贸n y digitas /** + enter, te va a poner los returno y los tags de par谩metros.

incre铆ble, esto no te lo muestran en la universidad

Hola! algo que acabo de descubrir es que al escribir los primeros caracteres de un comentario para javadoc /** y darle tabular (o tecla tab) autom谩ticamente el IDE completa el comentario con los tag de los par谩metros y sus nombres y el tag del return.

   /**
     * Descricin : Funcion que calcula el area de un circulo
     * @param r Radio de la circulo 
     * @return areaCircule : Devuelve  el area del circulo
     * */

    public static double cirlArea(double r){
        double areaCircule= Math.PI*Math.pow(r,2);
        return areaCircule;
    }


Estos momentos de felicidad cuando sabes cosas que No se Ense帽a en a Universidad

Implementando mi primer JavaDoc:
馃挌

Hola esta es la manera en la que utilize JavaDocs en este ejercicio.

    /**
     * <h3>Descripci贸n:</h3>
     * <p>Esta funcion nos permite obtener el Area de un circulo.</p>
     * <p>脷nicamente ingresando el <strong>radio</strong> como parametro.</p>
     * @param r Radio del circulo
     * @return Retorna el resultado de la operacion matem谩tica para calcular el 谩rea de un circulo.
     * */
    public static double circleArea(double r) {
        return Math.PI * Math.pow(r,2);
    }

Que excelente forma de documentar el c贸digo java, muy presentable y f谩cil de usar.

Nota: el que use NetBeans puede generar el JavaDoc en Run - Generata Javadoc

Esto de la documentaci贸n me pareci贸 genial, Java me esta empezando a parecer sexy.

En Windows para ver la documenta debemos hacer lo siguiente. Vamos a File > Settings:

Nos aparece una ventana de configuraciones, vamos en Editor > General > Code Completion y damos check a 芦Show the documentation popup in X ms禄:

Damos Ok. Ahora volvemos a escribir hasta que IntelliJ IDEA nos sugiera una opci贸n, pasamos el cursor encima y entonces s铆, nos aparece la documentaci贸n que hemos creado:

Mi futuro yo me lo agradecer谩, tanto como mi presente yo esta agradecido ahora 馃槂 . Excelente Clase 馃槈

el documentar es una buena practica que todo programador debe de realizar para facilitar el trabajo y saber que realiza cada paso de un c贸digo ya que cuando se programan proyectos grandes son varios programadores los que trabajan en un mismo proyecto y eso ayuda much铆simo al grupo

Que buena clase, muy importante, siendo que la mayor parte del tiempo uno est谩 leyendo c贸digo, ya sea propio o de alguien m谩s.

Me encant贸 esta lecci贸n. Documentar correctamente es muy 煤til para nuestro 鈥測o del futuro鈥, o bien, para alguien que se quede con el c贸digo que nosotros creamos.
Repito: Me encant贸 el tema.

Comparto por si a alguien le sirve:
Acced铆 en Windows a **File > Settings ** y como no encontraba Code Completion, puse completion en el buscador y me result贸. Slaudos

Excelente explicaci贸n y muy buena practica que debe ser regla para todo programador as铆 sea en su proyecto personal,

Wow buenas pr谩cticas

Todav铆a sigue sorprendi茅ndome como no conoc铆a esta forma tan 煤til de documentar el c贸digo y ahora aprendimos ciertos par谩metros a establecer y que acepta etiquetas HTML sencillas.
Por cierto, para los usuarios de Windows, la ventana de preferencias de IntelliJ la abren dando clic a File > Settings.

驴COMO HABILITAR QUE MUESTRE EL JAVADOC EN INTELLIJ? (que lo muestre en el pop up cuando te posicionas sobre el m茅todo o clase)

1- Click en el men煤 File
2- Click en la opci贸n settings
3- Opci贸n EDITOR < GENERAL < CODE COMPLETION
4- Seleccionar el check "Show the documentation popup in ---- ms"
Para generar la documentaci贸n de nuestra clase y poder verla en el navegador podemos hacer lo siguiente. Una vez comentado el c贸digo vamos a la terminal y ponemos el comando `javadoc <nombre de la clase>` : ![](https://static.platzi.com/media/user_upload/Screenshot%202024-03-14%20at%2011.23.49-b0974206-90da-4d52-a358-204d28755a6b.jpg) Esto har谩 que se generen varios archivos html, los podr谩s ver en la estructura del proyecto, el que nos importa es el archivo index.html: ![](https://static.platzi.com/media/user_upload/Screenshot%202024-03-14%20at%2011.27.37-2e2b6151-5cbe-44d5-a59a-10b4d9a8e58c.jpg)Desde la terminal podemos poner el siguiente comando para poder abrir ese archivo en el navegado: `open index.html `o en caso de windows: `start doc\index.html`. Luego nos aparecer谩 la siguiente p谩gina: ![](https://static.platzi.com/media/user_upload/Screenshot%202024-03-14%20at%2011.31.00-caec3e70-7511-4a60-a1a6-aef526930f84.jpg) Ah铆 se encontrar谩 la clase y la debemos de presionar. En la siguiente p谩gina nos encontraremos con los detalles de la clase y bajando un poco nos encontraremos con los comentarios que hicimos. ![](https://static.platzi.com/media/user_upload/Screenshot%202024-03-14%20at%2011.32.55-e077db28-2736-4880-a6cf-b4bf9fa8f633.jpg) Espero del ayude 馃
C贸digo comentado: ```js public class Funciones { /** * Descripci贸n: M茅todo Main, es el punto de entrada en donde empezar谩 a ejecutarse el programa 馃 * */ public static void main(String[] args) { double y = 3; circleArea(y); sphereArea(y); sphereVolume(y); System.out.println("PESOS A 馃捀DOLARES: " + convertirToDolar(1000, "COP")); } /** * Descripci贸n: Funci贸n para calcular el 谩rea de un c铆rculo ingresando la longitud de su radio; * @param r Longitud del radio del c铆rculo. * @return Math.PI * Math.pow(r,2) Devuelve el valor de la multiplicaci贸n de PI y el radio al cuadrado el cual es el 谩rea. * */ public static double circleArea(double r){ return Math.PI * Math.pow(r,2); } /** * Descripci贸n: Funci贸n que calcula el 谩rea de la superficie de una esfera ingresando la longitud del radio. * @param r Longitud del radio de la esfera. * @return Devuelve el 谩rea superficial de la esfera. * */ public static double sphereArea(double r){ return 4 * Math.PI * Math.pow(r,2); } /** * Descripci贸n: Funci贸n que calcula el volumen de la esfera ingresando la longitud del radio. * @param r Longitud del radio de la esfera. * @return Devuelve el volumen de la esfera. * */ public static double sphereVolume(double r){ return (4 * Math.PI * Math.pow(r,3))/3; } /** * Descripci贸n: Funci贸n que especificando su modena convierte una cantidad de dinero a d贸lares. * @param quantity Cantidad de dinero. * @param currency Tipo de Moneda: Solo acepta MXN COP * @return quantity Devuelve la cantidad actualizada en D贸lares * */ public static double convertirToDolar(double quantity, String currency){ //MXN COP switch (currency){ case "MXN": quantity *= 0.052; break; case "COP": quantity *= 0.00031; break; } return quantity; } } ```
Si est谩n comenzando en el mundo de la programaci贸n de 3 o 4 a帽os a la fecha valoren este tipo de contenido, hace 12 a帽os esto no ten铆a difusi贸n en cursos y la documentaci贸n era ambigua lo que le sigue, quien llegaba a saber era un eg贸latra que estaba criado a la vieja escuela. Valoren no toparse con ese tipo de dinosaurios y nunca paren de aprender
Porque no me dejo insertar normalmete como en el video el tipo de dato string ![](https://static.platzi.com/media/user_upload/image-fa22ef03-88a4-4e61-bb4e-99f60b134fb1.jpg)

Mis Apuntes de la Clase:

public class _012_Funcion_CoverterCurrency {
    /**
     * Descripcion: Funcion que especificando su moneda convierte una cantidad de dinero a dolares.
     * @param quantity Cantidad de dinero.
     * @param currency Tipo de Moneda ingresada. Solo acepta MXN, CORD, HNL.
     * @return quantity Devuelve la cantidad actualizda en Dolares.
     * */
    public static double converToDollar(String currency, double quantity){
        switch (currency){
            case "MXN":
               quantity = quantity/17.46;
                break;
            case "HNL":
                quantity = quantity/24.48;
                break;
            case "CORD":
                quantity = quantity/36.30;
                break;
        }
        return quantity;
    }

    public static void main(String[] args) {
        double money = converToDollar("HNL",500);
        System.out.println(money);
    }
}
:o buen铆simo
```java public class Funciones { public static void main(String[] args) { double y = 3; //Area e un Circulo = PI * r2 double circuleAreaarea = circuleArea(y); System.out.println("Area de un circulo = " + circuleAreaarea); //Area de una esfera = 4 * PI * r2 double sphereArea = sphereArea(y); System.out.println("Area de una esfera = " + sphereArea); //Volumen de una esfera = (4/3) * PI * r3 double sphereVolum = sphereVolumen(y); System.out.println(sphereVolum); System.out.println("Pesos a dolares: " + converToDolar(200, "MXN")); // Ejemplo de uso de las funciones int resultadoSuma = sumar(5, 3); System.out.println("La suma es: " + resultadoSuma); double areaRectangulo = calcularAreaRectangulo(4.5, 3.2); System.out.println("脕rea del rect谩ngulo: " + areaRectangulo); int numero = 7; if (esPar(numero)) { System.out.println(numero + " es un n煤mero par."); } else { System.out.println(numero + " no es un n煤mero par."); } } //Calcula el Area de un circulo /** * Calcula el 谩rea de un c铆rculo. * * @param r El radio del c铆rculo. * @return El 谩rea del c铆rculo. */ public static double circuleArea (double r){ return Math.PI * Math.pow(r,2); } /** * Calcula el 谩rea de una esfera. * * @param r El radio de la esfera. * @return El 谩rea de la esfera. */ //Calcula el Area de una esfera public static double sphereArea (double r) { return 4 * Math.PI * Math.pow(r,2); } //Calcula el Volumen de una esfera /** * Calcula el volumen de una esfera. * * @param r El radio de la esfera. * @return El volumen de la esfera. */ public static double sphereVolumen (double r) { return (4 / 3) * Math.PI * Math.pow(r,3); } /** La siguiente funcion convierte de pesos a dolares. * @param currency Tipo e moneda. Pesos mexicamos o pesos colombianos * @param quantity cantidad de dinero * @return quantity devuelve la cantidad actualizada en dolares * */ public static double converToDolar (double quantity, String currency){ //MXN, COP switch (currency){ case "MXN": quantity = quantity * 0.052; break; case "COP": quantity = quantity * 0.00023; break; } return quantity; } // Funci贸n que suma dos n煤meros enteros y devuelve el resultado /** * Suma dos n煤meros enteros y devuelve el resultado. * * @param numero1 El primer n煤mero entero a sumar. * @param numero2 El segundo n煤mero entero a sumar. * @return La suma de los dos n煤meros. */ public static int sumar(int numero1, int numero2) { int suma = numero1 + numero2; return suma; } // Funci贸n que calcula el 谩rea de un rect谩ngulo y devuelve el resultado /** * Calcula el 谩rea de un rect谩ngulo y devuelve el resultado. * * @param longitud La longitud del rect谩ngulo. * @param ancho El ancho del rect谩ngulo. * @return El 谩rea del rect谩ngulo. */ public static double calcularAreaRectangulo(double longitud, double ancho) { return longitud * ancho; } // Funci贸n que verifica si un n煤mero es par /** * Verifica si un n煤mero es par. * * @param numero El n煤mero a verificar. * @return true si el n煤mero es par, false si no lo es. */ public static boolean esPar(int numero) { return numero % 2 == 0; } } ``` public class Funciones { public static void main(String\[] args) { double y = 3; //Area e un Circulo = PI \* r2 double circuleAreaarea = *circuleArea*(y); System.*out*.println("Area de un circulo = " + circuleAreaarea); //Area de una esfera = 4 \* PI \* r2 double sphereArea = *sphereArea*(y); System.*out*.println("Area de una esfera = " + sphereArea); //Volumen de una esfera = (4/3) \* PI \* r3 double sphereVolum = *sphereVolumen*(y); System.*out*.println(sphereVolum); System.*out*.println("Pesos a dolares: " + *converToDolar*(200, "MXN")); // Ejemplo de uso de las funciones int resultadoSuma = *sumar*(5, 3); System.*out*.println("La suma es: " + resultadoSuma); double areaRectangulo = *calcularAreaRectangulo*(4.5, 3.2); System.*out*.println("脕rea del rect谩ngulo: " + areaRectangulo); int numero = 7; if (*esPar*(numero)) { System.*out*.println(numero + " es un n煤mero par."); } else { System.*out*.println(numero + " no es un n煤mero par."); } } //Calcula el Area de un circulo */\*\** *\* Calcula el 谩rea de un c铆rculo.* *\** *\* @param r El radio del c铆rculo.* *\* @return El 谩rea del c铆rculo.* *\*/* ** public static double circuleArea (double r){ return Math.*PI* \* Math.*pow*(r,2); } */\*\** *\* Calcula el 谩rea de una esfera.* *\** *\* @param r El radio de la esfera.* *\* @return El 谩rea de la esfera.* *\*/* ** //Calcula el Area de una esfera public static double sphereArea (double r) { return 4 \* Math.*PI* \* Math.*pow*(r,2); } //Calcula el Volumen de una esfera */\*\** *\* Calcula el volumen de una esfera.* *\** *\* @param r El radio de la esfera.* *\* @return El volumen de la esfera.* *\*/* ** public static double sphereVolumen (double r) { return (4 / 3) \* Math.*PI* \* Math.*pow*(r,3); } */\*\* La siguiente funcion convierte de pesos a dolares.* *\* @param currency Tipo e moneda. Pesos mexicamos o pesos colombianos* *\* @param quantity cantidad de dinero* *\* @return quantity devuelve la cantidad actualizada en dolares* *\* \*/* ** public static double converToDolar (double quantity, String currency){ //MXN, COP switch (currency){ case "MXN": quantity = quantity \* 0.052; break; case "COP": quantity = quantity \* 0.00023; break; } return quantity; } // Funci贸n que suma dos n煤meros enteros y devuelve el resultado */\*\** *\* Suma dos n煤meros enteros y devuelve el resultado.* *\** *\* @param numero1 El primer n煤mero entero a sumar.* *\* @param numero2 El segundo n煤mero entero a sumar.* *\* @return La suma de los dos n煤meros.* *\*/* ** public static int sumar(int numero1, int numero2) { int suma = numero1 + numero2; return suma; } // Funci贸n que calcula el 谩rea de un rect谩ngulo y devuelve el resultado */\*\** *\* Calcula el 谩rea de un rect谩ngulo y devuelve el resultado.* *\** *\* @param longitud La longitud del rect谩ngulo.* *\* @param ancho El ancho del rect谩ngulo.* *\* @return El 谩rea del rect谩ngulo.* *\*/* ** public static double calcularAreaRectangulo(double longitud, double ancho) { return longitud \* ancho; } // Funci贸n que verifica si un n煤mero es par */\*\** *\* Verifica si un n煤mero es par.* *\** *\* @param numero El n煤mero a verificar.* *\* @return true si el n煤mero es par, false si no lo es.* *\*/* ** public static boolean esPar(int numero) { return numero % 2 == 0; } }
public class Funciones { public static void main(String\[] args) { double y = 3; //Area e un Circulo = PI \* r2 double circuleAreaarea = *circuleArea*(y); System.*out*.println("Area de un circulo = " + circuleAreaarea); //Area de una esfera = 4 \* PI \* r2 double sphereArea = *sphereArea*(y); System.*out*.println("Area de una esfera = " + sphereArea); //Volumen de una esfera = (4/3) \* PI \* r3 double sphereVolum = *sphereVolumen*(y); System.*out*.println(sphereVolum); System.*out*.println("Pesos a dolares: " + *converToDolar*(200, "MXN")); // Ejemplo de uso de las funciones int resultadoSuma = *sumar*(5, 3); System.*out*.println("La suma es: " + resultadoSuma); double areaRectangulo = *calcularAreaRectangulo*(4.5, 3.2); System.*out*.println("脕rea del rect谩ngulo: " + areaRectangulo); int numero = 7; if (*esPar*(numero)) { System.*out*.println(numero + " es un n煤mero par."); } else { System.*out*.println(numero + " no es un n煤mero par."); } } //Calcula el Area de un circulo */\*\** *\* Calcula el 谩rea de un c铆rculo.* *\** *\* @param r El radio del c铆rculo.* *\* @return El 谩rea del c铆rculo.* *\*/* ** public static double circuleArea (double r){ return Math.*PI* \* Math.*pow*(r,2); } */\*\** *\* Calcula el 谩rea de una esfera.* *\** *\* @param r El radio de la esfera.* *\* @return El 谩rea de la esfera.* *\*/* ** //Calcula el Area de una esfera public static double sphereArea (double r) { return 4 \* Math.*PI* \* Math.*pow*(r,2); } //Calcula el Volumen de una esfera */\*\** *\* Calcula el volumen de una esfera.* *\** *\* @param r El radio de la esfera.* *\* @return El volumen de la esfera.* *\*/* ** public static double sphereVolumen (double r) { return (4 / 3) \* Math.*PI* \* Math.*pow*(r,3); } */\*\* La siguiente funcion convierte de pesos a dolares.* *\* @param currency Tipo e moneda. Pesos mexicamos o pesos colombianos* *\* @param quantity cantidad de dinero* *\* @return quantity devuelve la cantidad actualizada en dolares* *\* \*/* ** public static double converToDolar (double quantity, String currency){ //MXN, COP switch (currency){ case "MXN": quantity = quantity \* 0.052; break; case "COP": quantity = quantity \* 0.00023; break; } return quantity; } // Funci贸n que suma dos n煤meros enteros y devuelve el resultado */\*\** *\* Suma dos n煤meros enteros y devuelve el resultado.* *\** *\* @param numero1 El primer n煤mero entero a sumar.* *\* @param numero2 El segundo n煤mero entero a sumar.* *\* @return La suma de los dos n煤meros.* *\*/* ** public static int sumar(int numero1, int numero2) { int suma = numero1 + numero2; return suma; } // Funci贸n que calcula el 谩rea de un rect谩ngulo y devuelve el resultado */\*\** *\* Calcula el 谩rea de un rect谩ngulo y devuelve el resultado.* *\** *\* @param longitud La longitud del rect谩ngulo.* *\* @param ancho El ancho del rect谩ngulo.* *\* @return El 谩rea del rect谩ngulo.* *\*/* ** public static double calcularAreaRectangulo(double longitud, double ancho) { return longitud \* ancho; } // Funci贸n que verifica si un n煤mero es par */\*\** *\* Verifica si un n煤mero es par.* *\** *\* @param numero El n煤mero a verificar.* *\* @return true si el n煤mero es par, false si no lo es.* *\*/* ** public static boolean esPar(int numero) { return numero % 2 == 0; } }
/**
     * Calculates the area of a circle by specifying its radius and prints the result on the screen.
     * @param radius circle radius
     * */
    public static void calculateCircleArea(double radius) {
        System.out.println(Math.PI * Math.pow(radius, 2));
    }

    /**
     * Calculates the area of a sphere by specifying its radius and prints the result on the screen.
     * @param radius circle radius
     * */
    public static void calculateSphereArea(double radius) {
        System.out.println(4 * Math.PI * Math.pow(radius, 2));
    }

    /**
     * Calculates the volume of a sphere by specifying its radius and prints the result on the screen.
     * @param radius circle radius
     * */
    public static void calculateSphereVolume(double radius) {
        System.out.println(((double) 4 / 3) * Math.PI * Math.pow(radius, 3));
    }

Comparto mi documentacion para circlearea spherevolumen y spherearea 馃槉

/**
     * Descripci贸n:
     * Funci贸n nos da el 谩rea de un circulo
     * @param r Radio que recibe del circulo a sacar el area
     * @return Retorna el area del circulo teniendo en cuenta el radio
     * */
    public static double circleArea(double r){
        return (Math.PI * Math.pow(r,2));
    }
    /**
     * Descripci贸n:
     * Funci贸n nos da el 谩rea de una esfera
     * @param r Radio que recibe de la esfera a sacar el area
     * @return Retorna el area de la esfera teniendo en cuenta el radio
     * */
    public static double sphereArea(double r){
        return (4 * Math.PI * Math.pow(r,2));
    }
    /**
     * Descripci贸n:
     * Funci贸n nos da el volumen de una esfera
     * @param r Radio que recibe de la esfera a sacar el volumen
     * @return Retorna el volumen de la esfera teniendo en cuenta el radio
     * */
    public static double sphereVolumen(double r){
        return (4/3F * Math.PI * Math.pow(r,3));
    } 

Ya podrian otros lenguages implementar esto, que util.

Wooooow :0

Buenas, paso mis JavaDocs

/**
 * Descripcion: Funci贸n para calcular el 谩rea de un circulo.
 *
 * @param r Recibe como parametro el radio del circulo.
 * @return Devuelve un valor double con el 谩rea del circulo.
 *
 * */
    public static double circleArea(double r){
        return Math.PI * Math.pow(r,2);
    }

    /**
     * Descripci贸n: Funcion para calcular el 谩rea de una esfera.
     *
     * @param r Recibe como parametro el radio de la esfera.
     * @return Devuelve un double con el valor del 谩rea de una esfera.
     * */
    public static double areaEsfera(double r){
        return 4* Math.PI * Math.pow(r,3);
    }
/**
 * Deswcripcion: Funcion para calcular el volum茅n de una esfera.
 *
 * @param r Recibe el radio de la esfera como parametro.
 * @return Devuelve un double con el vol煤men de la esfera.
 * */
    public static double volumenEsfera(double r){
        return ((4/3) * Math.PI * Math.pow(r,3));
    }

    /**
     *Description: Function to convert Uruguayan and Mexican currency to dolars
     *
     * @param quantity Cantidad de dinero(Money quantity).
     * @param currency Tipo de Moneda: solo acepta MXN - UYU.
     * @return quantity Devuelve la cantidad actualizada en dolares.
     * */
    public static double convertToDolar(double quantity, String currency){
        //UYU MXn
        switch (currency){
            case "UYU":
                quantity = quantity * 0.02545;
                break;
            case "MXN":
                quantity = quantity * 0.0542;
                break;
        }
        return quantity;
    }

Excelente clase. No sabia que esta era la forma correcta de comentar, jamas nadie antes me la habia ense帽ado.

Mi pr谩ctica de la clase (NetBeans 16, Java 19):

Para poder ver la informaci贸n en NetBeans deben posicionarse sobre el nombre del m茅todo mientras presionan la tecla 鈥淐trl鈥.

C贸mo no aprend铆 esto antes jaja demasiado bueno!

Gracias que clase mas genial para aplicar en la documentaci贸n de nuestros programas.

Como activar la documentaci贸n de JavaDocs

Creando un JavaDocs para documentar tu c贸digo

jejejejejje olvidense de documentar a mano, para eso ya estan las extensiones de VSC como mintlify con un ctrl . o alt . ya genera automaticamente la doc de la funcion que este debajo del cursor

No conoc铆a esta herramienta de Java, es muy 煤til para comprender lo que programamos.
Muy interesante Java!

Los comentarios de javadocs se escriben pensando en tu yo futuor o para que otroa programdores lo entiendan.
Al comentar una funci贸n para Javado:

  1. Primero se pone la descripci贸n,

  2. Luego documentar los par谩metros de la funci贸n con el tag @param seguido del nombre y una descripci贸n.

  3. Finalmente el valor de retorno con el tag @return seguido del nombre de la variable y una descripci贸n.

Documentacion

Un libro que ayuda a la hora de mejorar como programadores, es Codigo Limpio Robert C. Martin. En este libro se aprende referente a como ser mas eficientes a la hora de programar

Ame esta clase

buena clase

馃槺Sin palabras馃槺
Quien no documenta su c贸digo en Java es simplemente por que no quiere. Gracias Profe Anah铆

Wow Gracias Anah铆, esto es muy importante a la hora de trabajar con muchas funciones y clases

Para ver el doc de Math la profesora hizo un ctrl click sobre la palabra Math

Buenisimo, no sabia sobre esta funcionalidad. Muy util y que genial ir sabiendo las buenas practicas desde ya.

javadoc

Seg煤n lo que vi del IDE, el tag @return no formatea un nombre de variable, solamente espera la descripci贸n de lo que retorna la funci贸n/m茅todo

    /**
     * Descripci贸n: Funci贸n que devuelve el area de un circulo
     * @param r radio
     * @return formula
     */

    public static double circleArea(double r){
        return Math.PI * Math.pow(r,2);
    }
    
    /**
     * Descripci贸n: Funci贸n que devuelve el area de una esfera
     * @param r radio
     * @return formula
     */
    
    public static double sphereArea(double r){
        return 4 * Math.PI * Math.pow(r,2);
    }
    
    /**
     * Descripci贸n: Funci贸n que devuelve el volumen de una esfera
     * @param r radio
     * @return formula
     */
    public static double sphereVolumen(double r){
        return (4/3) * Math.PI * Math.pow(r,3);
    }

    /**
     * Descripci贸n: Funci贸n que especificando su moneda convierte una cantidad de dinero a d贸lares
     * @param quantity Cantidad de dinero
     * @param currency Tipo de moneda: Solo acepta MXN o COP
     * @return quantity Devuelve la cantidad actualizada en Dolares
     */

    public static double converToDolar (double quantity, String currency){
        switch (currency){
            case "MXN":
                quantity *= 0.052;
                break;
            case "COP":
                quantity *= 0.00031;
                break;
        }
        return quantity;
    }

public class funciones {

public static void main(String[] args) {
  
            public int suma (int a, int b){
                return a+b; // el valor de regreso, especificar el valor de regreso
             }
       LLAMAR  FUNCION:
       int c = suma (5,7);
       // retorna el resultado en la variable c
     */

    // IMPLEMENTAR FUNCIONES
    double x = 2.134;
    double y = 3;
    // Calculo del area de un Circulo
    // llamamos a la funcion y almacenamos el resultado en la variable area
   circleArea(y);
   roundNumber(x);
   roundFlorNumber(x);
   powNumbers(x,y);
   maxNumber(x,y);
   mathSqrt(x);
   spheraArea(y);
   spheraVolumen(y);
   double quantity = 5000;
   String currency = "COP";
   convertToDolar(quantity,currency);

}

    // LAS FUNCIONES VIVEN AL NIVEL DE LA CLASE, SALIMOS DEL METODO MAIN.
    // STATIC: PARA METODOS QUE COMPARTEN EL METODO MAIN

/**
 * Descripcion: Esta funcion, devuelve el area del circulo
 * @param y: es el radio del circulo
 * @return: retorna el valor del area ya calculado, luego de utilizar la formula
 */
public static double circleArea (double y){
        double area= 0;
        area = Math.PI*Math.pow(y,2);
        System.out.println("EL AREA ES "+area);
        return area;
    }

/**
 * Descripcion: Redondea a un numero superior el numero ingresado
 * @param x: es el numero a redondear
 * @return r: retorna el numero redondeado a un numero superior.
 */
public  static double roundNumber (double x){
        double r;
        r = Math.ceil(x);
        System.out.println("EL NUMERO REDONDEADO ES "+r+" EL NUMERO ORIGINAL ERA: "+x );
        return r ;
    }

/**
 * Descricion: Redondea a un numero inferior el numero ingresado
 * @param x: es el numero a redondear
 * @return r: retorna el numero redondeado a un numero inferior.
 */
public  static double roundFlorNumber (double x){
        double r;
        r = Math.floor(x);
        System.out.println("EL NUMERO REDONDEADO AL MENOR ES "+r+" EL NUMERO ORIGINAL ERA: "+x );
        return r ;
    }

/**
 * Descripcion: Devuelve el numero elevado al exponente de un segundo numero
 * @param x: es la base de la potencia
 * @param y: el exponente al cual elevamos la base
 * @return r: es el resultado de la potencia de dos numeros.
 */
    public static double powNumbers(double x , double y){
    double r =0;
    r = Math.pow(x,y);
    System.out.println("LA BASE ES "+x + " ELEVADO AL EXPONENTE "+ y + " EL RESULTADO ES "+ r);
    return r;
    }

/**
 * Descripcion: esta funcion devuelve el numero mayo de sos numeros ingresados
 * @param x: numero 1 a comparar
 * @param y: numero 2 a comparar
 * @return r: devuelve el numero mayor de los 2 ingresados
 */
public  static double maxNumber (double x, double y){
    double r;
    r = Math.max(x,y);
    System.out.println("EL NUMERO MAYOR ES "+r);
    return r ;
}

/**
 * Descripcion: Devuelve la raiz cuadrada de un numero dado
 * @param x: el numero a sacar la raiz cuadrada.
 * @return r: el resultado de la raiz cuadrada.
 */
public  static double mathSqrt (double x){
    double r;
    r = Math.sqrt(x);
    System.out.println("LA RAIZ CUADRADA DE  "+x + " ES "+ r );
    return r ;
}

/**
 * Descripcion: Devuelve el area de una esfera
 * @param y: es el radio de la esfera
 * @return r: el resultado del calculo del area de la esfera
 */
public static double spheraArea (double y){

    double r=0;
    r = Math.PI*4*Math.pow(y,2);
    System.out.println("EL AREA DE LA ESFERA ES "+r);
    return r;
}

/**
 * Descripcion: Devuelve el volumen de una esfera
 * @param y:  es el radio de la esfera
 * @return: el resultado del calculo del volumen de la esfera
 */
public static double spheraVolumen(double y){
    double r = 0;
    r = (Math.PI*(4/3)*Math.pow(y,3));
    System.out.println("EL VOLUMEN DE LA ESFERA ES "+r);
    return r;
}

/**
 * Descripcion: Especificamos la cantidad de la moneda, y la convierte a dolares
 * @param quantity Cantidad de dinero a convertir
 * @param currency Tipo de moneda a seleccionar, solo acepta pesos mexicanos "MXN" o pesos  colombianos "COP"
 * @return  quantity devuelve la cantidad actualizada en dolares.
 */
public static  double convertToDolar(double quantity, String currency){

    switch (currency){
        case "MXN": quantity = quantity * 0.052;
            System.out.println("LA CANTIDAD DE PESOS MEXICANOS ES "+ quantity );
        break;
        case "COP": quantity = quantity * 0.00029;
            System.out.println("LA CANTIDAD DE PESOS COLOMBIANOS ES "+ quantity );
            break;
        default:
            System.out.println("SELECCIONE UNA OPCION VALIDA");
            break;
    }
return quantity;
}

}

Que genial!!! Realmente pondr茅 en pr谩ctica esto

Todo muy claro. Gracias

Es una autentica genialidad facilitar el trabajo de documentar al que esta escribiendo el c贸digo en tiempo real y al que quiere entenderlo despu茅s es una autentica genialidad

Wooouw!! no sab铆a esa forma de documentar , sin duda esto se me har谩 costumbre.

muy genial que se pueda ver la descripci贸n de nuestras propias funcionesen a veses el c贸digo se pone tan extenso que uno se comienza a olvidar de lo que ya programo

Genial, no sabia hacer eso y lo he utilizado jejejej.

Ctr + Q abre los DocInfo en IntelliJ y otro IDE de la empresa.