La importancia de la documentación
En programación, es vital una buena organización. Gracias a esto conseguiremos que en un futuro podamos, y puedan 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.
Espacio publicitario
Con el fin de que no tengas que estar descifrando el código más adelante, o que lo tengan que hacer otras personas que trabajen contigo, documentaremos bien los programas y los dejaremos bien ordenados.
En este capítulo, 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.
Además, te mostraré como presentar bien el código mediante
las tabulaciones.
¿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 y caracteres especiales en los comentarios, procura no utilizarlos cuando estés trabajando en una empresa. No se recomienda utilizarlos más que dentro de los strings.
Probablemente trabajes con más gente y te tengas que comunicar en inglés.
A partir de aquí, iremos utilizando los comentarios 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 con un 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 muestra el saludo
FinAlgoritmo // Termina el algoritmoComo puedes ver, cualquiera que no sepa incluso nada de programación, entendería bastante como funciona este algoritmo. Gracias a los comentarios.
Espacio publicitario
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 apropiado, será 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
FinAlgoritmoY por cierto, mira como dejando espacios entre líneas y grupos de líneas relacionadas, se lee mejor.
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.
¿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 en el algoritmo.
Tabulaciones, saltos de línea y espacios
Volviendo al código tabulado y espaciado que acabas de ver, 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, 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 SPACE, ENTER o TAB , las veces que creas conveniente para separar las cosas. El resultado en la salida de la consola es el mismo.
Un buen ejemplo de lenguaje de programación y
tabulaciones, es Python, en el cual 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.
Utilizo el término indentación porque está muy extendido en la comunidad hispanohablante. Pero debes saber que indentar, es un anglicismo que proviene de indentation, y realmente, la forma correcta en español es sangrar (acción de aplicar sangría) o tabular (de la tecla tabulador).
Espacio publicitario
Espacio publicitario