Que comentar en un programa de computadora



Encabezado general del programa (o librería): a) nombre del programa o líbrería, b) nombre del programador, c) fecha de realización, d) versión actual, e) propósito de todo el programa, f) breve descripción del programa o líbrería, g) historial del desarrollo del programa y, h) bibliográfía o referencia a documentación externa.

Encabezado particular de cada rutina:

a) nombre de la rutina, b) descripción de parámetros (entradas y salidas), c) propósito de la rutina, d) breve descripción del método aplicado, e) bibliográfía o referencia a documentación externa.

Explicación del nombre y uso de los identificadores principales (variables, constantes, procedimientos y funciones). De utilizar abreviaturas, indique la convención utilizada.

Descripción breve de las funciones de cada sección y del funcionamiento de cada módulo, así como los parámetros requeridos. Indicar si alguno de los parámetros puede tomar sólo algunos valores específicos, o tienen un significado especial.


Si en un momento dado el preparar la documentación puede provocar que se pierda alguna idea fundamental para el funcionamiento del programa, entonces efectuar pequeños comentarios e ir marcando el programa, para posteriormente ampliar esos comentarios.

Usar un estilo de programación claro y elegante para facilitar la lectura. Destacar las partes relacionadas y los bloques.

a) Usar líneas en blanco para diferentes partes del programa. b) Sangrías consistentes (entre dos y cuatro espacios). c) Marcar con un comentario el inicio y el final de cada sección importante .

No comentar lo obvio:

a) No repetir lo que realiza el código. b) No usar expresiones coloquiales propias de un área de trabajo en particular.

Evitar los trucos o explicarlos claramente.

Como ejemplo, considere este programa en lenguaje C . No le diremos qué es, ni que hace, pero le aseguramos que funciona.

Si el lenguaje es árido (por ejemplo, ensamblador, lisp u otro) entonces describa el algoritmo aplicado mediante comentarios. Gracias a María del Carmen Ozuna por colaborarnos este artículo para ser publicado en ARQHYS.com…

Para citar este articulo en formato APA: Revista ARQHYS. 2011, 08. Que comentar en un programa de computadora. Equipo de colaboradores y profesionales de la revista ARQHYS.com. Obtenido , de https://www.arqhys.com/general/que-comentar-en-un-programa-de-computadora.html.





Canales.


Nosotros | Política de Privacidad | Contácto