Formas y Técnicas de Documentar Algoritmos y Programas

Formas de representar un algoritmo

Pseudocódigo.

- Es una técnica para el diseño de programas que permite definir las estructuras de datos.

Diagrama De Flujo.

- Es una técnica que representa de forma grafica los algoritmos ,aunque su empleo a disminuido considerablemente por la aparición de los lenguajes de programación .

Diagrama N-S.

- también conocido como diagrama de Chapín es una técnica de especificación de algoritmos que combina la descripción textual, propia del pseudocódigo, con la representación gráfica del diagrama de flujo. 

Formas y Técnicas de documentar un algoritmo y un programa Son comentarios, etiquetas de texto, que facilitan la comprensión del programa Documentación La documentación del programa es fundamental para diseñadores y usuarios .En pseudocódigo solo se documentarán los algoritmos internamente, esto es, se efectuarán comentarios de ciertas acciones o grupos de acciones para permitir al diseñador o al equipo del diseño releer el algoritmo con facilidad.

Para documentar internamente un algoritmo en pseudocódigo se empleará la doble barra () y a continuación el texto o la frase explicativa .Al ejecutar el algoritmo, este texto a la derecha de la debe ser ignorado, pues no constituye a una acción algorítmica.

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 que ademá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 ha dedicado 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 aquello de 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 un nuevo escenario. Hay dos reglas que no se deben olvidar nunca: 

Todos los programas tienen errores y descubrirlos sólo es cuestión de tiempo y de que el programa tenga éxito y se utilice frecuentemente 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, bien por el programador original, bien por otro programador que le sustituya.