Inicio | Artículos | Cursos Online | Libros | Diccionario | Mapa Web | Enlazar | Contactar | Acerca de


C/C++/C# HTML Java JavaScript Linux PHP Python Swift
CURSO/TUTORIAL DE ALGORITMOS
Introducción
¿Qué es un Algoritmo?
¿Qué es un Ordinograma?
Elementos Básicos
Tipos de Datos
Identificadores
Variables
Constantes
Operadores y Expresiones
Tipos de Datos Definidos por el Programador
Datos de Tipos Enumerados
Datos de Tipos Subrangos
Instrucciones Primitivas
Instrucción de Asignación
Instrucción de Salida
Instrucción de Entrada
Estructura de un Algoritmo
Partes de un Algoritmo
Cabecera
Declaraciones
Cuerpo
Sintaxis de un Algoritmo
Comentarios
Introducción a los Diagramas de Flujo
Asignación
Entrada y Salida
Inicio y Fin
Decisiones
Instrucciones de Control
Instrucciones Alternativas
Instrucciones Repetitivas
Instrucciones De Salto
Llamadas a Subalgoritmos
¿Qué es un Subalgoritmo?
Subprogramas
Procedimientos
Declaraciones Locales y Globales
Parámetros
Funciones
Representación mediante Diagramas de Flujo
CarlosPes.comCurso de Diseño de Algoritmos > Comentarios de un Algoritmo

Comentarios de un Algoritmo

¿Cómo se escriben los comentarios de un algoritmo?

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 de algoritmos, 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: Algoritmo que sirve para calcular el área de una circunferencia, en el cual se han comentado las distintas secciones: cabecera, declaraciones y cuerpo:
/* 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: Algoritmo que incluye comentarios acerca de su autor, fecha, etc.
/***************************************************/
/* 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
Artículos Interesantes
Artículos de Desarrollo Web
Artículos de Informática
Artículos de Programación
Artículos de SEO
Cursos/Tutoriales de Informática
Curso/Tutorial de Algoritmos
Curso/Tutorial de Informática Básica
Curso/Tutorial de Ingeniería del Software
Curso/Tutorial de Lenguaje C
Curso/Tutorial de Marketing en Internet
Curso/Tutorial de Turbo Pascal
Curso/Tutorial de Representación de los Datos
Curso/Tutorial para Webmasters
Curso/Tutorial Web 2.0
Curso de SEO
Libros de Carlos Pes
36 Pasos Básicos para Desarrollar un Sitio Web
Empezar de Cero a Programar en Lenguaje C
Fundamentos del SEO
Libros Recomendados
Libros de Analítica Web
Libros de Desarrollo Web
Libros de Java
Libros de Lenguaje C
Libros de Marketing Online
Libros de Pascal (Turbo Pascal)
Libros de SEO
Libros de Visual Basic
Recursos de Informática
Diccionario de Informática
Ejercicios de Programación
Guías de uso de Software
Sintaxis de Lenguajes de Programación
Biografías
Entrevistas
Frases y Citas
Recursos Educativos
Presentaciones Educativas
Videos Educativos
Enlaces Web
Acerca de Carlos Pes
Bibliotecas
Colaboradores
Contactar
Enlazar
Librerías
Perfiles en Internet
Mapa Web
Blog de Carlos Pes Blog de Carlos Pes
© CarlosPes.com | Privacidad | Condiciones