El fin de documentar el código de un programa es simplemente hacer que los demás entiendan que está haciendo el programa o porque lo hace, y no que nada más la computadora entienda el código.

Créanme entre saber lo que tiene que hacer un programa y cómo lo hace hay una distancia inmensa, así también agregando las horas que el programador dedico a la solución. Mira documentar un programa no es porque el programador quiera hacer la buena obra de dejar todo escrito, si no que podemos apreciar la documentación cuándo tenemos errores que reparar o talvez cuándo tengamos que hacer más grande el programa (agregar más módulos, etc.) o bien adaptarlo a un nuevo escenario.

Investigando encontré está información

¿Qué debemos documentar?

  • ¿De que se encarga tal clases?
  • ¿Qué hace tal método?
  • El usó de algunas variables importantes
  • El algoritmo que estamos usando
  • Limitaciones del programa

Yo creó que hay muchas más razones por las que debemos documentar de igual manera te invito a que nos des tú punto de vista a lo mejor para ti el “documentar” no es adecuado siéntete libre de darnos tu punto de vista.

El hablar de los tipos de comentarios depende mucho del lenguaje de programación que estés usando.

Una línea de código

//

Javadoc

/**” varias líneas de código

Tipo c

/*

Como te digo depende mucho del lenguaje de programación que estés utilizando.

Te paso el link en el que me base para escribir la información de está publicación.

Por otra parte quiero hacerte llegar otra información, espero que sea de gran útilidad.

Manuales técnicos o manuales de mantenimiento

Esta documentación está destinada a los programadores y ayuda de referencia para dar manteminiento a un sistema dentro de su vida útil. Los tipos de documentación dentro de éstos manuales son internas y externas. La documentación Interna: se refiere a los comentarios que encontramos dentro del programa fuente (detalles significativos de un programador). La documentación Externa: se refiere a toda aquella información que se encuentra independiente del programa por ejemplo manuales impresos que se otorga junto con el programa aquí es dondé se describen todas las características técnicas del programa y su funcionamiento.

Manual del Usuario

Este manual no es más que un documento que le indica o le ayuda al usuario a conocer, utilizar y operar de una manera correcta el sistema o programa que se ha desarrollado, se describen los objetivos y características externas.

 

Autor: Telecristy

Posts Relacionados

Comments

comments

Deja una respuesta

Tu email no será publicado. Los campos requeridos estan marcados con *
Puedes usar tags HTML y los atributos: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code class="" title="" data-url=""> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong> <pre class="" title="" data-url=""> <span class="" title="" data-url="">