Java Docs

Me sorprende lo cool que es Java. Siempre había pensado lo contrario de este lenguaje.

Si llegaste hasta este video debo de darte un consejo muy importante:

Si hay una sola cosa a la que le vas a dedicar 100% de tu atencion que sea a esto, por favor, jamas dejes de comentar tu codigo, no solo puedes ahorrarle un dolor horrible de cabeza a tus colegas sino a ti mismo, tu yo del futuro te lo agradecera 😃

Documentación de uso de Javadoc
El siguiente sitio describe la herramienta javadoc e incluye ejemplos de uso y etiquetas válidas para Windows.

Es bastante practico aunque algo tedioso para un junior buscar la documentación javadoc pero cuando te acostumbras esta bueno porque ya buscas directamente lo que deseas.

Saludos.

Definitivamente esta era una de las cosas de las que no tenía conocimiento. Espero poder aprender más de Java y así lograr certificarme y especializarme en este lenguaje.

🤔 Documentar el código es esencial para el mantenimiento y trabajo en equipo

No les pasa que en la u o en el colegio les explicaron todo como a las patadas y los traumaron con java, y llegaron por x razón a este curso y todo es hermoso

JAJAJAJA Ame cuando dijo de sacar los frankstein de Stackoverflow xd.

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticament

Importante para tener en cuenta ya que la gran mayoría de desarrolladores no utiliza el javadoc

Eso mismo me paso con Cobol y es un lenguaje genial. La verdad es que estos lenguajes una vez que los aprendes son fantásticos. Vale que son complicaditos, pero merecen la pena.

https://docs.spring.io/spring-boot/docs/2.2.0.M3/api/

Hola chicos, usen chatGPT cuando no se acuerden de la sintaxis o quieran saber para que funciona una clase, les ahorrará tiempo.

Aunque por otra parte también es bueno saber como buscar en la documentación oficial que hace tal cosa.

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente

Demasiado importante, ya que un codigo puede ser muy extenso, y luego se nos puede olvidar, que hace que

Me daba mucha pereza Java pero estos cursos están geniales y le he cogido cariño. Gracias.

• Los Java Docs son una herramienta usada por michas otras herramientas y aplicaciones porque nos ayuda a documentar todo nuestro código usando comentarios. Además nos permite visualizar la documentación en formato HTML.
• Nos ayuda a comprender qué hace el código.
• Genera documentación HTML.

Es el primer lenguaje de programación que estudio y me parece super cool.

JAVADOC herramienta muy utilizada que nos permite comprender que hace el codigo, ayuda a ilustrar y a entender mas a fondo lo que esta escrito, el resultado del Javadoc es la documentacion en HTML para entrega del proyecto o para compartirlo con el equipo de desarrollo

Excelente aporte jamas dejemos de comentar nuestro codigo.

Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases y métodos de Java. La mayoría de los IDEs los generan automáticamente.

Uso

• Los comentarios de JAVADOC se generan desde el código fuente y, por lo tanto, hay que incluir en el mismo etiquetas especiales para poder interpretarlas en la generación. La etiqueta que determina un comentario JAVADOC es /**…*/
• Un comentario JAVADOC está compuesto de una definición seguida de un bloque de etiquetas relacionadas

/** 
* Comentario para generar Java Docs 
* */

/**
* Frase corta descriptiva
* Descripción de la clase
* @author Nombre Apellido / Empresa
* @version 0.1, 2004/05/30
*/

fuente:

• https://www.oracle.com/ar/technical-resources/articles/java/javadoc-tool.html
• https://www.juntadeandalucia.es/servicios/madeja/contenido/recurso/109

• Con tan solo utilizando comentarios yo puedo declarar mi java doc.
• //Comentario en una línea.

Java Doc:
-Nos ayuda a comprender que hace el código
-Genera Documentación HTML

No había escuchado acerca de javadoc y la verdad me parece genial;
Cuando recibí clases de java en el SENA, el profesor nunca se esmero por dar clases con conceptos claros nos impartió usando netbeans y fue una pésima experiencia, gracias a estas clases me esta gustando mucho java.

/**
me entusiasma aprender java
*/

Documentation Generator

excelente

Me gusta Java

wow, qué maravillosa fue esta clase!
Yo nunca había escuchado de javadoc, aunque siempre me enseñaron que documentar es importante
Después de conocer sobre esto, mi vida no volverá a ser la misma

Esto no lo entendí

1. //COMENTARIOS EN UNA SOLA LINEA
   /*

2. COMENTARIOS EN MULTIPLES LINEAS
   

   */
3. /**
   Esta es la documentacion que el compilador si va a leer
   */

Documentar el codigo que se esta haciendo
Utilizar la herramienta Javadoc, es una herramienta que ayuda entender el codigo.

Nos va a documentar la coumentacion en HTML.

Guia que ilustra sin usar internet.

Genera documentacion
Las constantes se crean con mayusculas separadas con guiones bajos.

Se declara en JavaDoc creando documentos

JavaDoc nos ayuda a identificar en que estamos haciendo para que las personas que trabajan con nosotros también puedan ver todo y no estar perdidos, es muy útil. //

muy bueno las clases

Me gusta mucho la documentación

DATO: Este tipo de documentacion en HTML es importarte para compartirla con tu equipo de trabajo y si llega un programador nuevo

<public class Funciones {

    /*
    * Linea 1
    * Linea 2
    *
    * */

    /**
     * 
     * */
    public static void main(String[] args) {
        double y = 3;
        //Area de un circulo
        //pi * r2

        circleArea(y);
        System.out.println(circleArea(y));

        //Area de una esfera
        //4*PI*r2
        sphereArea(y);
        System.out.println(sphereArea(y));

        //Volumen de una esfera
        //(4/3)*pi * r3
        sphereVolumen(y);
        System.out.println(sphereVolumen(y));

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

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

    public static double sphereArea(double r){
        return 4 * Math.PI * Math.pow(r,2);
    }

    public static double sphereVolumen(double r){
        return (4/3) * Math.PI * Math.pow(r,3);
    }

    public static double convertToDolar(double quantity, String currency){
        switch (currency){
            case "MXN":
                quantity = quantity * 0.049;
                break;
            case "COP":
                quantity = quantity * 0.00023;
                break;
        }

        return quantity;
    }
}
> 

Amo como Java en VSC asiste en todo

public class Functions_Statements {
  public static void main(String[] args) {

    int radio = 4;
    System.out.println("The area of a circle with a radius of " 
      + radio + " is " + Area_de_un_circulo(radio)
    );

    System.out.println("The are of sphere with radio of " 
      + radio + " is " + Area_de_una_esfera(radio)
    );

    System.out.println("The are of sphere with radio of " 
      + radio + " is " + Area_de_una_esfera(radio)
    );

    System.out.println("cilinder with radio of " 
      + radio + " and height of " + radio 
      + " is " + Volumen_de_un_cilindro(100, 19)
    );

    System.out.println("MXN to USD "
      +convert_To_Dollar(1000, "MXN")
    );
  }

  public static double Area_de_un_circulo(double radio) {
    return Math.PI * Math.pow(radio, 2);
  }


  public static double Area_de_una_esfera(double radio) {
    return 4 * Math.PI * Math.pow(radio, 2);
  }


  public static double Volumen_de_una_esfera(double radio) {
    return (4/3) * Math.PI * Math.pow(radio, 3);
  }


  public static double Volumen_de_un_cilindro(double radio, double altura) {
    return Math.PI * Math.pow(radio, 2) * altura;
  }


  public static double convert_To_Dollar(double quantity, String currency) {
    switch (currency) {
      case "MXN" -> quantity = (quantity * 0.057);
      case "COP" -> quantity = (quantity * 0.00031);
    }
    return quantity;
  }
}```

Confirmo, me gusta JAVA;

Hasta aquí JAVA es verdaderamente bueno y cómodo para programar. A seguir !!!

Usando los comentarios se puede declarar en el JavaDocs. Se utiliza: /** */

Muy buena clase. Gracias.

Los Java Docs son una herramienta usada por muchas otras herramientas y aplicaciones porque nos ayuda a documentar todo nuestro código usando comentarios. Además, nos permite visualizar la documentación en formato HTML.

Que tuanis eso de comentar/documentar en Javadoc.

Muy interesante la clase, a pesar que para algunas personas es algo tedioso documentar, es muy importante la documentación de código.

Estas son las clases que de verdad son un tesoro🎁

Esta cool comentar con Javadoc.

Gracias JavaDoc

no sabia que java tenia esta facilidad para hacer documentación de código fuente ,simplemente interesante

No sabia que Java tenia esto

Siempre había escuchado este término, sin embargo, nunca le presté atención o no recibí la enseñanza adecuada. La clase es muy clara a contunuar.

Genial!! No tenía idea de esto!

Muy interesante.

/**

• Comentario para Java Docs
• */

wow no sabia tampoco de esta herramienta

muy chevere la documentación de java, ahorra mucho tiempo en consultas a internet

Llevaba tiempo preguntándome como hacer una documentación de código, hoy me has sacado de la duda!

Sumanente completo este lenguaje.

Por favor siempre documentar, como programadores no lo hacemos mucho , pero como ayuda

Genial.

Buen aporte, explica muy bien. Apenas estoy empezando y realmente he entendido sin ningún problema

Mostré esto en la universidad y mi profresor no sabía que existía

La verdad que en el video pasado descubrí lo bonito de Java, y recién vamos comenzando 😃

Estupenda clase, conocía los dos primeros tipos de comentarios, pero el tercero no sabía que existía y la importancia que tiene para documentar las distintas partes de nuestro código.

Como es la forma de introducir datos desde el teclado al momento de correr el programa? Eso se puede? Como un input

😃

No conocía esto.

Necesarias 😃

Muy importante para facilitar la comprension del script.

me parece muy interesante, me permite buscar información en un solo sitio

public class JavaDoc {
	public static void main(String[] args) {
		
		String name="Platzi!";
		System.out.println("Hola "+name);
		
		/*
		 * Result:
		 * Hola Platzi!
		 */
	}

}

Siempre he querido saber como se genera la documentación con JavaDocs (si ponía los comentarios pero jamás lo he visto generado) espero en la otra clase lo digan

Vamos platzi

esto no lo concocía, excelente

Muy claro. Gracias

Toda mi vida me reúse a aprender java y ahora me encanta.

Que fácil se entiende algo cuando la persona que lo enseña esta completamente dedicada a ello.

Desconocía esto de Java, me parece genial!

La verdad estoy sorprendido, cuando tomé el curso lo hacía mas porque es muy demandado en la industria, pero de verdad que se hace muy agradable

increíble

Siempre le he tenido miedo al Backend, de momento, no hay diferencia en cuanto a como se maneja la programación y la manera de escribir código. vmaos avanzando

Me encanto javadoc; excelete para buenas practicas 😊 💻

Documentación.

 /**
     *
     *
     */