Tags Java Docs

Asi es

No tenia ni idea de que existía esto, algo que no enseñan en la universidad…

En intelliJ IDEA hay que ir a “Tools” y después “Generate JavaDoc” le das un path para que lo guarde y listo.

Creo que debería existir un curso específico para hacer documentación. Es un tema muy amplio, muy importante pero que se ve muy pocas veces. Además hay formas muy específicas de generar documentación. Es todo un tema.

Lo que aprendí 6 meses de carrera lo aprendí en 2 días en platzi.

con permiso me llevo una screenshot de esto. se que dentro de no mucho voy a necesitarlo.

messirve 😎

Ahora si que podré entregar los trabajos bien documentados!

JAVADOCS ❕ ❕ ❕ La salvación de los programadores 😎

Lo mas cercano a aprender de esto en la universidad son los comentarios con //, pero javadocs jamas los vi en fundamentos de programación.

Esto es lo más intersante de este curso, hasta el momento

Excelente, siento que si hubiera conocido sobre como hacer documentación antes me hubiera salvado de varias cosas en la universidad

Excelente esta parte no tenia esto claro solo documentaba todo a nivel de comentarios pero con esto de los Javadocs la verdad es alucinante la forma de documentar el codigo, me ha sido ya de mucha utilidad.

Cómo escribir comentarios de documentos para la herramienta Javadoc
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
https://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags

En Netbeans (por si alguien está usando esa IDE), se ingresa a la opción EJECUTAR, en el menu superior; luego se ingresa a la opción GENERAR JAVADOC (PRACTICA) y se muestra el resultado en el navegador predeterminado en HTML

soy muy novato . pero esto de documentar me ayudara mucho

Cómo generar documentación en HTML:

GUI: https://mariocelis.com/java/crear-documentacion/
Command line: https://www.baeldung.com/javadoc

Con este conocimiento puesto en practica nos perfilamos como programadores de excelencia y le damos un plus a nuestro código.

¡Muchas gracias!

Esto es completamente nuevo para mi, pero me parece una practica excelente.

Me parece genial lo que javadoc nos proporciona por que nos permite recordar la funcionalidad de nuestro código a pesar que lo hubiéramos dejado de revisar por un tiempo gracias Platzi por este conocimiento !!

Si bien es cierto la documentación es importante, pero la verdad que muy pocos lo hacemos, a veces lo más práctico resulta usar nuestros nombres de clases, atributos, variables, funciones, lo más descriptivo posible, que con solo leerlo ya sabemos que almacena o que cálculo hace.

considero que como buenos programadores debemos adoptar buenas practicas iniciando por documentar nuestro codigo ta como lo mencionaban en la clase ya sea para recordarlo nosotros mismos o bien para ayudar a los futuros programadores que le darán mantenimiento por muy sencillo que pueda ser.

Ty por la informacion! lo copie en un txt para consultarlo cuando no tenga internet 😃

ES MUY IMPORTANTE DOCUMENTAR EN NUESTROS PROYECTOS PARA NO OBVIAR Y SER EFECTIVOS EN FUTUROS CAMBIOS O MODIFICACIONES

Cuando me dieron la clase de programación estructurada, no nos enseñaron a como documentar código, realmente este hubiese sido de mucha utilidad en aquel entones

Se puede documentar todas las clases utilizando estos tags hasta ahí todo bien pero cómo lo exportamos a HTML? O en alguna ruta del proyecto ya genera el Index de la página?

Maravilloso ahora puedo documentar mejor aplicaciones.

Excelente!

Siempre me había preguntado, ¿que eran esas cosas? ,es excelente.

¡Genial!
Ahora a practicar mas documentando nuestras funciones, incluyendo estos tags 😃

Buenisimo, es lo que me faltaba!

Muy buen aporte y bastante util para una mejor comprension del codigo.

Muy bueno, es de mucha ayuda para el aprendizaje
Gracias

Excelente…!

ok

Muy agradecido con esta clase, con Anahi y Platzi.

Excelente aporte

Muy buen aporte. Gracias.

gracias

que buenazo!

/*JAVA Docs
      @author: Es el autor de la clase
      {@code}: muestra texto en formato de codigo sin que sea interpretado como HTML
      {@docRoot}: Indica la ruta relativa al directoorio raiz del documento generado desde cualquier pagina generada
      @deprecated: Se pone indicando que esta API no debe usarse mas
      @exception: Se indica cuando es vulnerable a lazar una excepcion, en seguida se ponen las class  de las excepciones posibles
      {@inheritDoc}: Indica la herencia o implementacion procedentadora
      {@link}: hace un enlace a la mienbro indicado
      {@linkplain}: el  etxto se muestra en texto plano xd
      @param: añande parametros con nombres especificos, seguido de su descripcion
      @return: Asigna un parametro de retorno, seguido de su descripcion
      @see: se añade para manejar referencias, o informacion relacionada
      @serial: Se utiliza paar indicar campos o clases seriales
      @serialData: se utiliza para documentar metodos que generan una serializacion
      @serialField: se utiliza para documentar objetos serializados
      @since: se añade en el encabezado para especificar dsde cuando fue creado 
      @throws: es sinonimo con la etiqueta @exception
      {@value}: cuando es usado sin argumento se usa para especificar un campo estatico en otro caso se usa para mostar el valor contante
      @version: se añade en el subtitulo con la version especificada
    * */
    /**
     * Descripcion: funcion que especificando su moneda convierte una cantidad de dinero a dolares
     *
     * @param quantity cantidad de dinero
     * @param currency Tipo de moneda: Solo acepta MXN o COP
     * @return quantity Devuelve la cantida en dolares
     * */
    public static double converToDolar(double quantity, String currency){
        switch (currency){
            case "MXN":
                quantity = quantity * 0.052;
                break;
            case "COP":
                quantity = quantity * 0.00025;
                break;
        }
        return quantity;
    }

genial esto por dios y yo matandome en un word escribiendo la docyumentacion de mi codigo o por dios me encanta esto

Indagare mas afondo para entender esta documentación y como comenzar a utilizarla…

Bueno ahora necesito una clase para javadoc y en general las buenas practicas de como documentar, si no no podre dormir sabiendo puedo ser un mejor desarrollador

Uff, mil gracias por esta lista

😀 Este apartado complementa la información de Java Docs.

Este video será de mucha ayuda para la implementación de java docs.
https://www.youtube.com/watch?v=b3J7sfdlnpk

Me gusta mucho la implementación de los java docs. me ayuda mucho

Aplicar este tipo de cosas son las que hacen que un código se vea y parezca profesional.

Muy útil esta información, sin embargo tengo una duda en ocasiones he visto el tag @Override en java y no entiendo del todo que significa, alguien podria hacerme el favor de explicarme?, gracias.

Si todos documentáramos nuestro código, cualquiera lo puede comprender.

La documentación del código es una excelente practica en todos los lenguajes, y da el entendimiento a otras personas que necesiten hacer algún mantenimiento al mismo.

muy interesante esta forma de documentar el proyecto
literal, antes abría otra clase, y era muy extraño ver todo eso

Es de verdad una buena practica ya que nos ayuda a entender nuestro código y se deja ordenado para los demás, al momento de realizar troubleshooting se hace mas fácil, adicional se hace mas fácil al momento de reutilizar código.

genial

Que buena info, este curso y el de marketing son los que mas me han gustado

Gracias, muy buen curso.

Excelente curso para ir retomando

Excelente aporte… 😃

Super útil!!

Eso va a servir mucho!!

Me encanta el manejo de Java Docs, creo que debes implementar esta herramienta desde el inicio del proyecto. Los tags profesionalizan el trabajo de los Java Docs.

Ahora todo tiene sentido, buen dato!

Muy interesante todo esto de la documentación, realmente es útil para todos los que vayan a usar nuestro código.

Muy buena informacion

Es super útil, nunca había tenido en cuenta la documentación. Voy a empezar a implementarla, gracias!

super cool

Me sale este error cuando genero el Javadoc :
jdk path is not specified or invalid javadoc
A que se deberá
Gracias

Muy bueno!, gracias!

Bien explicado el tema

Excelente muchas gracias por este super dato

Igual que Arturo, dudaba para que que eran esas sintaxis, gracias Anncode

gracias

Muchas gracias instructora Anahí por compartir los tags específicos de Java Docs.

Todo muy claro. Gracias

Excelente Curso

genial!

Perfecto!

Buen aporte

Excelente aporte.

Gracias , por el aporte.

Genial, informacion guardada.

Gracias 😃 Necesitaba un ejemplo así para mi clase jiji

genial! lo tendré presente de ahora en mas.

MUCHAS GRACIAS EXCELENTE APORTE SEGUIMOS APRENDIENDO

😃

gracias por la aclaración.

Gracias 😃

Aclaramos varias cosas gracias a este javaDoc

Muchas gracias por estos datos.

Excelente Info, Gracias Teacher

Gracias, me falta aprender algunos ❤️

Muchas gracias, esto es excelente

Me encanta! 😄 . Es bueno tener en cuenta Java Doc. Ya que, en mi trabajo como desarrollador de software se me ha dificultado entender el código de los demás y de mi yo del pasado. Más que todo por falta de documentación de código, que por desconocimiento del lenguaje de programación. Así que, a documentar nuestro código para que los demás y tu yo del futuro lo agradezcan 😄 . Gracias por compartir la información.

Gracias, buen soporte …

Muchas gracias por esto!

Interesante

Gracias 😃