Documentar en Java

Imos ver como crear documentación do xeito máis eficaz empregando extensións en VSCode.

O teu traballo:

Na páxina do VSCode cóntanos todo o que aconsella instalar:

• Java Platform Extension for Visual Studio
• CodeExtension Pack for Java
• Javadoc Tools
• Debugger for Java

😉Eu na casa tiven que instalar antes esto en Win 11 e buscalo en F1/Java: Configure RunTime 🤫

Fai un fork e descarga este pequeno repo no teu ordenador.

1. O ficheiro Boas.java seguro que o dominades pero imos intentar que nos documente automaticamente eso tan sinxelo: F1/Generate JavaDocs Comments for Open File Vedes o que fai? Agora vós mesmos deberíades substituír o que deixa marcado coa información que consideredes relevante.
2. Analizade agora o ficheiro Punto.java e volvede a documentalo automaticamente.
3. Que tal agora co Vehiculo.java?
4. Fai capturas de pantalla e explica no teu blog como queda a túa documentación

Recursos para aprender a documentar estupendamente

• https://guides.lib.berkeley.edu/how-to-write-good-documentation
• https://docs.github.com/es/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes
• https://docs.github.com/es/communities/documenting-your-project-with-wikis/about-wikis