IMPORTANCIA DE DOCUMENTAR UN ALGORITMO

Documentar un algoritmo permite conocer que es lo que se est realizando en

el programa. Son instrucciones que no modifican el algoritmo, pero permite
recordar en un futuro posterior lo que se hizo en el cdigo. Documentar un
algoritmo permite que el cdigo pueda ser comprendido por quien realiza algn
mantenimiento o simplemente se informe de cmo est trabajando dicho
algoritmo. Adems, sirve para el mismo programador, ya que le permite poder
recordar lo que estuvo realizando de cmo fue la lgica que empleo.
Para documentar un algoritmo se pueda realizar luego de las lneas que se
est escribiendo, o simplemente donde el programador vea conveniente su
uso. Adems, necesario escribir todas las variables y constantes que se estn
usando, lo que hace cada uno de ellos, los procesos que intervienen para el
funcionamiento. Por lo que debe ser comprensible al momento de leer, en el
que me pueda dar la informacin del algoritmo.
Los smbolos que se usan para poder identificar un comentario depende del
lenguaje que se est usando, ya que muchos de los lenguajes de programacin
presentan un mecanismo de documentacin. Adems, los comentarios son
muy fciles de visualizar en un cdigo, ya que tienen una identificacin
particular en el cdigo.