|
|
| Contenidos > 7.4
Comentarios |
|
|
| 7.4 Comentarios |
|
|
|
En
los algoritmos es conveniente escribir comentarios
para explicar el diseño
y/o funcionamiento del mismo. Para delimitar los comentarios se pueden
utilizar distintos caracteres:
- ([) y (])
- ({) y (})
- (/*) y (*/)
- ...
En pseudocódigo,
en este curso, los comentarios se van a escribir entre los
símbolos reservados barra-asterisco
(/*)
y asterisco-barra
(*/),
que son los mismos que se utilizan en lenguaje C.
Ejemplo 1:
Para comentar las secciones del algoritmo Area_de_una_circunferencia
se puede escribir:
/* Cabecera */
algoritmo Area_de_una_circunferencia
/* Declaraciones */
constantes
PI =
3.141592
variables
real
area, radio
/* Cuerpo */
inicio
escribir(
"Introduzca radio: "
)
leer( radio )
area ←
PI * radio ** 2
escribir( "El
área de la circunferencia es: ",
area )
fin |
Cuando un algoritmo se convierta (codifique) en un programa,
también se podrán escribir los comentarios en el código
fuente
de dicho programa. Dichos comentarios no afectarán nunca a
la
ejecución del programa. No obstante, serán muy
útiles a la hora de querer saber qué hace un
algoritmo (o
programa), y cómo lo hace.
Los comentarios de un algoritmo (o programa) forman parte de la documentación
del mismo, pudiendo:
- Informar sobre
algunos datos
relevantes del algoritmo (autor, fecha de creación, fecha de
última modificación, proyecto en el que se
integra,
versión,... ).
- Explicar la
utilidad de uno o más tipos de datos, constantes y/o
variables.
- Describir el
funcionamiento general del algoritmo (o programa).
- Explicar el
cometido de una o más instrucciones.
- Etc.
Ejemplo 2:
/***************************************************/
/* Programa:
Calcular_area_circunferencia
*/
/*
*/
/* Descripción: Recibe por teclado el
radio de una */
/* circunferencia, mostrando su área
por pantalla. */
/*
*/
/* Autor:
Carlos
Pes
*/
/*
*/
/* Fecha:
31/03/2005
*/
/***************************************************/
/* Cabecera
*/
algoritmo Area_de_una_circunferencia
/* Declaraciones */
constantes
PI =
3.141592
variables
real
area, radio
/* Cuerpo */
inicio
escribir(
"Introduzca radio: "
)
leer( radio )
area ←
PI * radio ** 2
escribir( "El
área de la circunferencia es: ",
area )
fin |
|
|
|
|
|
|
|
