piratita

Documentación.
Documentar el código de un programa es añadir suficiente información como para explicar lo que hace, punto por punto, de forma que no sólo los ordenadores sepan qué hacer, sino queademás los humanos entiendan qué están haciendo y por qué.
Porque entre lo que tiene que hacer un programa y cómo lo hace hay una distancia impresionante: todas las horas que el programador hadedicado a pergeñar una solución y escribirla en el lenguaje que corresponda para que el ordenador la ejecute ciegamente.
Documentar un programa no es sólo un acto de buen hacer del programador por aquellode dejar la obra rematada. Es además una necesidad que sólo se aprecia en su debida magnitud cuando hay errores que reparar o hay que extender el programa con nuevas capacidades o adaptarlo a unnuevo escenario. Hay dos reglas que no se deben olvidar nunca:
1. todos los programas tienen errores y descubrirlos sólo es cuestión de tiempo y de que el programa tenga éxito y se utilice frecuentemente2. todos los programas sufren modificaciones a lo largo de su vida, al menos todos aquellos que tienen éxito
Por una u otra razón, todo programa que tenga éxito será modificado en el futuro, bienpor el programador original, bien por otro programador que le sustituya. Pensando en esta revisión de código es por lo que es importante que el programa se entienda: para poder repararlo y modificarlo.Estilo de programación
 También llamado estándares de código o convención de código) es un término que describe convenciones para escribir código fuente en ciertos lenguajes de programación.El estilo de programación es frecuentemente dependiente del lenguaje de programación que se haya elegido para escribir. Por ejemplo el estilo del lenguaje de programación C variará con respecto al dellenguaje BASIC.


El Estilo de Programación como Documentación
El principal contribuyente de la documentación a nivel de código no son los comentarios, sino el buen estilo de programación, el...