Los comentarios y la indentación en PSeInt

En la programación, es fundamental el orden y la documentación. Gracias a esto, conseguiremos que en un futuro, podemos leer y entender mucho mejor nuestros programas. Ya que si escribimos miles de líneas de código al día, es imposible recordar lo que hace todo.

Con el fin de que no tengas que estar descifrando el código más adelante, o que otras personas que trabajen contigo, lo tengan que hacer, documentaremos bien los programas y los dejaremos bien ordenados.

En este apartado, no voy a contarte como hacer una documentación completa, pero si a hacer su parte más básica, los comentarios en el código.

¿Qué son los comentarios en programación?

Los comentarios en programación, son pequeños aportes de información en el código. En PSeInt se escriben con dos barras: //.

"Comentarios" en inglés se dice "comments".

Cada lenguaje de programación tiene su propia sintaxis de comentarios, pero todos los tienen.

Aunque puedes utilizar acentos para tí en tu prácticas con acentos y caracteres especiales, no se recomienda utilizarlos más que dentro de los strings. Esto es una recomendación por si tienes que trabajar internacionalmente.

A partir de aquí, los iremos utilizando para que practiques. Es algo que debes poner siempre.

Por ejemplo, el algoritmo del apartado anterior, se podría comentar así:

// Algoritmo para mostrar un saludo al usuario con su nombre
Algoritmo saludo // Empieza el algoritmo
	Definir nombre Como cadena // Se define la variable
	nombre<-"Enrique" // Se inicializa la variable
	Escribir "Mi nombre es ",nombre // Se le muestra el saludo al usuario
FinAlgoritmo // Termina el algoritmo

Como puedes ver, cualquiera que no sepa incluso nada de programación, entendería bastante como funciona este algoritmo. Gracias a los comentarios.

Sin embargo, cuando empieces a hacer cosas más elaboradas, no hace falta que pongas tantos comentarios, ya que no se suelen escribir para quién no sabe programar. Se escriben para quién programa, que sepa de primeras lo que hace el programa o el algoritmo.

Algo más adecuado, sería esto:

// Algoritmo para mostrar un saludo al usuario con su nombre
Algoritmo saludo
	// Declaración y asignación de la variable
	Definir nombre Como cadena
	nombre<-"Enrique"
	// Frase de salida con el saludo
	Escribir "Mi nombre es ",nombre
FinAlgoritmo

Por el momento, no te preocupes por la cantidad de comentarios que pones. Tú ves poniendo lo que te haga falta. Si quieres poner un montón mientras practicas, adelante, te servirán para repasar.
Con el tiempo, ya irás viendo donde poner un comentario y donde puede sobrar.

Los comentarios también sirven para anular código. Solo hay que poner las dos barras en la línea que quieras anular. Esto se hace para hacer pruebas con los algoritmos sin borrar nada. Ya lo verás en el módulo de Python básico.

En la mayoría de lenguajes de programación, hay dos o más tipos de comentarios. Hablando de sintaxis. Por ejemplo, en JavaScript tenemos los comentarios de una línea con el operador //.

¿Por qué no afectan al algoritmo todas estas palabras de los comentarios?

Los comentarios son ignorados por el intérprete de PSeInt. Eso quiere decir, que cuando ejecutas el programa, es como si no existieran esos comentarios.

El orden e indentación en los programas

En los programas y algoritmos, el orden es fundamental. Este programa, a ojos del intérprete, es lo mismo. Va a funcionar.

// Algoritmo para mostrar un saludo al usuario con su nombre
Algoritmo saludo
// Declaración y asignación de la variable
Definir nombre Como cadena
nombre<-"Enrique"
// Frase de salida con el saludo
Escribir "Mi nombre es ",nombre
FinAlgoritmo

Pero, ¿qué te parece esta otra forma de presentar el código?

// Algoritmo para mostrar un saludo al usuario con su nombre
Algoritmo saludo
	
	// Declaración y asignación de la variable
	Definir nombre Como cadena
	nombre <- "Enrique"
	
	// Frase de salida con el saludo
	Escribir "Mi nombre es ", nombre
	
FinAlgoritmo

Se ve todo más claro, ¿no? Se ve muy bien donde empieza una cosa y donde acaba. Además, si te fijas, he añadido espacios entre el operador de asignación y el identificador de la variable y su valor, así no está todo pegado. También en la frase de salida, después de la coma.

Los espacios en blanco (vacíos) son ignorados por el intérprete, así que puedes utilizar la tecla espacio, enter o tabulador, las veces que creas conveniente, para separar las cosas. El resultado es el mismo.

A las tabulaciones en programación se les conoce como indentaciones o identaciones. Lo he visto en español escrito y hablado de las dos formas. Yo siempre utilizo "indentación".

Utilizo indentación en lugar de identación, puesto que en inglés, la palabra original es "indentation" y no "identation". Identación, probablemente provenga de traducir indentation con la n muda o más apagada que puede sonar como "identayshon". Sin embargo, he de decir que indentar, es un anglicismo y realmente, la forma correcta sería "sangrar" (acción de aplicar sangría) o "tabular" (de la tecla tabulador).

En Python, las indentaciones son obligatorias. Es de los pocos lenguajes que dan errores si no las ponemos correctamente. Esto te fuerza a escribir código mejor ordenado y presentado, pero al empezar a programar, puede ser confuso para algunos. Otros lenguajes de programación como Java, utilizan unas llaves en lugar de obligar con la indentación. Sin embargo, lo correcto es siempre indentar.

Esto ya lo veremos bien cuando lleguemos al siguiente módulo, el de Python básico.