Conceptos básicos

Uso de comentarios

¿Qué es un comentario?

Un comentario es una parte del código que no se ejecuta cuando el programa corre.

Su propósito es explicar qué hace el programa, aclarar decisiones de diseño o dejar notas para el futuro.

  • No afecta el comportamiento del programa.
  • No ocupa memoria ni tiempo de ejecución.
  • Es solo para las personas, no para la computadora.

¿Para qué sirven los comentarios?

  • Para explicar qué hace una parte del código.
  • Para recordar por qué se tomó cierta decisión en la programación.
  • Para desactivar temporalmente alguna línea de código (comentándola) sin eliminarla.
  • Para mejorar la legibilidad y el mantenimiento de proyectos grandes.

Tipos de Comentarios en PSeInt:

1. Comentario de una sola línea:

Se comienza con el símbolo //. Todo lo que escribas después será ignorado por el programa.

Ejemplo:
  // Este programa calcula la suma de dos números

2. Comentario de varias líneas:

Puedes usar /* para abrir y */ para cerrar un bloque de comentario que ocupe varias líneas.

Ejemplo:
  /*
  Este programa calcula la suma de dos números
  Ingresados por el usuario
  y muestra el resultado.
  */

Buenas prácticas para comentar código:

Usar comentarios correctamente es una señal de un buen programador. Aquí algunas recomendaciones:

  • Sé claro y breve: Explica lo necesario, no sobrecargues el código con comentarios innecesarios.
  • Comenta partes importantes o complejas: No es necesario comentar instrucciones obvias
  • Actualiza los comentarios si cambias el código: Un comentario desactualizado puede confundir más que ayudar
  • Evita comentar todo el código palabra por palabra: Lo ideal es comentar bloques o ideas, no cada línea
  • Usa comentarios para dividir el código en secciones: Esto hace que tu programa sea más ordenado y fácil de leer.

Ejemplo de uso de comentarios:

  // Programa para calcular el doble de un número
						
  Algoritmo DobleNumero
      Definir numero, resultado Como Entero
						
      // Pedimos al usuario que ingrese un número
      Escribir "Ingrese un número:";
      Leer numero;
						
      // Calculamos el doble
      resultado = numero * 2;
						
      // Mostramos el resultado
      Escribir "El doble es: ", resultado;
  FinAlgoritmo