Uso de comentarios

¿Qué es un comentario?

Un comentario es una línea o parte del código que no se ejecuta. Sirve para que el programador (tú u otros) entienda mejor el código.

Los comentarios son ignorados por la computadora. 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?

• Explicar lo que hace una parte del código.
• Recordar decisiones de diseño.
• Desactivar temporalmente una línea de código sin eliminarla.
• Hacer que el programa sea más legible y fácil de mantener.

Los comentarios son señal de buenas prácticas de programación.

Tipos de Comentarios en PSeInt:

En PSeInt puedes escribir comentarios de dos formas: para una sola línea o para varias líneas.

Comentario de una sola línea:

• Se escribe usando // al inicio de la línea.
• Todo lo que esté después de los // será ignorado por el programa.

Ejemplo:

// Este programa calcula la suma de dos números
Definir a, b, suma Como Entero

Comentario de varias líneas:

• Se abre con /* y se cierra con */.
• Todo el texto entre esos símbolos será tratado como comentario.

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:

Los comentarios bien usados mejoran la claridad del programa y facilitan su mantenimiento.

Recomendaciones clave:

• Sé claro y breve: Explica lo justo y necesario, no sobrecargues el código con comentarios innecesarios.
• Comenta partes importantes o complejas: No es necesario comentar instrucciones obvias.
• Mantén los comentarios actualizados: Si cambias el código, actualiza también los comentarios.
• Evita comentar cada línea del código: Lo ideal es comentar bloques o ideas, no cada línea.
• Divide el código por secciones usando comentarios: Esto hace que tú programa este más ordenado y sea más fácil de leer.

Ejemplo de uso 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