# // Buenas practicas de programación(Documentación)

# // Buenas practicas de programación(Documentación)

1. Ventajas al documentar

   • Más fácil de entender
   • Más fácil de modificar
   • Solo lo ve el programador
   • Más fácil de entender código de otros al trabajar en equipos

2. ¿Por que es importante documentar?

   • saber por que hiciste esa linea de código
   • Identificar más fácil como funciona el código
   • Los demás puedan entender el código
   • Más fácil encontrar errores
   • Saber que modificaron los demás

3. ¿Que es documentar?

   • Documentar es cuando dejamos una nota en el código el cual solo el programador puede ver, pero el usuario no.

4. ¿Que se debe documentar?

   • De lo que se encarga una clase o un paquete
     • Debe ir al inicio
     • Etiquetar con: @author @version
   • De lo que hace un método
     • Debe ir al inicio
     • Etiquetar con: @param @return @exeption or throws
   • Cuando el código no sea muy evidente
   • A lo largo de los bucles
   • Cunado hagamos algo raro