DOCUMENTACIÓN

La documentación es la etapa que consiste en la descripción de cada uno de los pasos que conllevan a la solución del problema y su importancia radica en la facilidad que otorga para leer un programa, depurarlo y hacerle ajustes y mantenimiento. Existen dos tipos de documentación:

En los ejercicios a desarrollar, se irán dejando líneas de comentarios al interior del programa, que le permitirán hacer mayor claridad sobre cada sentencia o procedimiento que requiera explicación. Estas líneas se inician con los caracteres “//” y dan explicación del procedimiento, o sentencias que siguen a la continuación del comentario.

En el siguiente ejemplo se toma el ejercicio que determina si un número ingresado por el usuario es positivo o negativo, debidamente documentado en el programa PSeInt. Como se puede observar, los comentarios inician con los caracteres “//” y el texto aparece de color gris.

Imagen 1. Ejemplo de algoritmo en PSeInt donde se muestran los comentarios.