10058380
Description
Mind Map by Osmi Santiago OTALORA GUERRERO, updated more than 1 year ago
|
Created by Osmi Santiago OTALORA GUERRERO
over 7 years ago
|
|
# // Buenas practicas de
programación(Documentación)
- 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
- Más fácil de
entender
- ¿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
- saber por que hiciste
esa linea de código
- ¿Que es documentar?
- Documentar es cuando dejamos una nota en
el código el cual solo el programador puede
ver, pero el usuario no.
- Documentar es cuando dejamos una nota en
el código el cual solo el programador puede
ver, pero el usuario no.
- ¿Que se debe documentar?
- De lo que se encarga una
clase o un paquete
- Debe ir al inicio
- Etiquetar con:
@author
@version
- Debe ir al inicio
- De lo que hace un
método
- Debe ir al inicio
- Etiquetar con:
@param @return
@exeption or throws
- Debe ir al inicio
- Cuando el código no
sea muy evidente
- A lo largo de los bucles
- Cunado hagamos algo raro
- De lo que se encarga una
clase o un paquete
Want to create your own Mind Maps for free with GoConqr? Learn more.