Generado Java Docs

Si están en IntelliJ la opción esta en Tools > Generate JavaDocs

Hola a todos.
Realmente es una clase bastante importante, he aprendido mucho, sin embargo, creo que en el minuto 2:35 la profesora Anahí tuvo una equivocación, ya que menciona que la anotación @see se utiliza en herencia múltiple, pero en Java no es permitida la herencia múltiple, más bien el tipo de herencia que se está utilizando es la herencia multinivel dado que Chapter hereda de Movie y Movie de Film, solo quería hacer la observación de que @see se está utilizando más bien para la herencia multinivel.
Saludos a todos.

para el error de html y se muestren los caracteres especiales(usado en intllij):

-html5 -encoding utf8 -docencoding utf8 -charset utf8

Me esta muy bueno en serio es una herramienta muy buena porque siempre escribimos mucho codigo que aveces ni nosotros no recordamos que es lo que hace

Gracias por el video Ann, la verdad yo no usaba la opción Generate JavaDoc, pero me pareció super util y ahora la uso siempre!!!

Yo les recomiendo actualizar la versión de eclipse, porque a mí no me dio problemas, tengo la versión
Eclipse Java 2018-09
Saludos

Me dio risa al final del vídeo xD, he trabajado para casi todos los bancos acá en Chile y en la mayoría la documentación de las clases es un mito xD

yo la verdad tiendo a inclinarme a escribir el código auto-documentado . Simplemente creo que está más limpio y si el código habla por sí mismo, bueno … Eso es genial .

Por otro lado tenemos documentación como javadocs. También me gusta esto, pero hay un cierto riesgo de que los comentarios aquí queden desactualizados (como también los comentarios en general). Sin embargo, si están actualizados pueden ser extremadamente útiles, por ejemplo, para comprender un algoritmo complejo.

¿Cuáles son las mejores prácticas para esto? ¿Dónde traza la línea entre el código de auto-documentación y javadocs?

Algo a considerar, si el nombre de sus parametros con la etiqueta @param
No coincide con el nombre de sus parametros en codigo y el log les va a indicar un error al momento de generar su javadoc.

No habia utilizado la Documentacion.!!

Si les aparece el "Javadoc command" en blanco, lo único que tienen que hacer es buscar la carpeta de de java y buscar su jdk que tienen instalado en su computadora, despues se van a bin/javadoc.exe
en mi caso donde tengo instalado mi jdk es aquí:

C:\Program Files\Java\jdk-10.0.2\bin\javadoc.exe

muy chevere

Me gustó mucho, si se va comentando de forma adecuada desde el principio genera una documentación muy completa.

Muy util, lo usare en mis proyectos desde ya!

Excelente aportación, solo resaltar que en el ámbito laboral, ya sean bancos, instituciones de gobierno o privadas siempre te pedirán documentar en INGLES, así que es super importante aprenderlo

javadoc error - cannot read input length = 1 en eclipse

Super muchas gracias 😃

Ayuda no logro que funcione.

excelente clase y explicación sobre Documentación!!!

Muy bueno implementar java doc, desde ahora lo implemento en mis proyectos.

Una pregunta platzi tiene slack seria genial asi nos comunicamos mejor

Me parece muy chevere ya que ahorra mucho trabajo, porque la documentación es importante

Al generar el javadocs me imprimía errores en todas las tildes y signos de admiración, lo intenté configurar en IntelliJ adaptando el UTF-8 pero no funcionó, así que mejor eliminé todas las tildes que habían, si alguien sabe la configuración en IntelliJ por favor publicarla.

Se ve Genial.

Muchas gracias por la clase instructora Anahí, en el caso de IntelliJ lo genera correctamente.
   

Si no les sale la ruta en la opcion:

Javadoc command

solo den click en Configure… y seleccionen javadoc.exce; que se encuentra en la siguiente ruta o donde tengan instalado su jdk:

D:\sw\java\x64\jdk7\bin\javadoc.exe

Yo tuve dos inconvenientes generándolos con IntelliJ:

• Al generar la documentación, hay que asegurarse de no usar etiquetas h1 (Supongo yo que es con el fin de que cada página tenga sólo una etiqueta h1). Pueden ser h2 o h3

• Tenía un problema de codificación del charset, por lo que los caracteres especiales como ñ y tildes se mostraban erróneamente. Esto es bien fácil de solucionar. Cuando están en la ventana de generar JavaDoc, en la parte donde dice “Command line arguments”, ponen lo siguiente:

-encoding utf8 -docencoding utf8 -charset utf8

Excelente explicación y demostración de lo que se logra con la JavaDoc

Excelente, adicionalmente la documentación es un elemento totalmente relevante en todo código de programación.