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
- 😉Eu na casa tiven que instalar antes esto en Win 11 e buscalo en F1/Java: Configure RunTime
- 🤫 En Linux
apt install default-jre default-jdke despois configurar o path
Cando teñas todo funcionando … Fai un fork e descarga este pequeno repo no teu ordenador:
- 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.
- Analizade agora o ficheiro Punto.java e volvede a documentalo automaticamente.
- Que tal agora co Vehiculo.java?
- Fai capturas de pantalla e explica no teu blog como queda a túa documentación
Recursos para aprender a documentar estupendamente:
-
- Guía de documentación de Berkeley.
- Tags de JavaDoc e un enorme exemplo de documentación.
- Uso dos README.md
- Uso dun wiki nun repositorio.



