Mini-guía de estilo en Scratch (A3C34A2D08)

Aunque Scratch sea un lenguaje de programación visual y fácil de comprender, resulta importante seguir una serie de buenas prácticas a la hora de trabajar con él. En esta guía se muestra un conjunto de buenas prácticas y convenciones que puedes seguir al escribir código en Scratch. Esto nos ayudará a escribir código limpio, legible y fácil de mantener, y nos evitará cometer errores que dificulten la comprensión y el mantenimiento del código.

Aprenderemos a elegir nombres adecuados para nuestras variables y bloques, cómo utilizar comentarios, y a cómo organizar y estructurar el código para que sea más legible.

• Utilizar nombres descriptivos para las variables y recursos. Los nombres deben ser claros y concisos, y deben transmitir de manera efectiva el propósito de lo que representan. Por ejemplo, en lugar de utilizar un nombre como «x», podríamos utilizar «puntuación» para una variable que almacena la puntuación de un juego. Por otra parte, en lugar de tener un recurso con el nombre «Sprite113», podríamos darle un nombre más significativo como «PersonajePrincipal»
  
  
• Utilizar abreviaturas y acrónimos con cuidado. Si se utilizan abreviaturas o acrónimos en los nombres de las variables, debemos asegurarnos de que sean conocidos y fáciles de entender. De lo contrario, es mejor utilizar un nombre completo y descriptivo.
  
  
• Utilizar una convención de nombres estándar. Las convenciones de programación son un conjunto de directrices concreto que recomienda estilo, prácticas, y métodos de programación. En este caso, podemos utilizar una convención de nombres estándar para las variables y los bloques, de tal forma que nos permita organizar mejor el código y hacerlo más legible. Por ejemplo, podemos hacer que las variables globales (aquellas que se pueden utilizar en cualquier lugar del proyecto) empiecen siempre con una letra mayúscula, mientras que las variables locales (las que solo se pueden utilizar en un determinado bloque) lo hagan siempre con una letra minúscula. De esta forma, resultaría más sencillo diferenciar entre variables locales y globales.

• Añadir comentarios a los bloques para explicar su funcionamiento. Los comentarios son líneas de texto que se ignoran al ejecutar el programa, pero que nos permiten añadir explicaciones y notas al código para hacerlo más legible y fácil de entender. En Scratch, podemos añadir comentarios a los bloques de código o a la propia área de trabajo (llamados flotantes); en ambos casos, se añaden mediante click derecho y seleccionando la opción «Añadir comentario»:

• Utilizar comentarios para documentar tus bloques personalizados. Cuando crees un bloque personalizado, es importante que añadas un comentario que explique su funcionamiento y su uso. De esta forma, otros usuarios que utilicen tu código podrán entender mejor cómo funcionan tus bloques personalizados y cómo utilizarlos en su propio proyecto.
  
  
• Utilizar comentarios para documentar las decisiones importantes que se hayan tomado al crear el programa código. Por ejemplo, si se ha utilizado un determinado algoritmo para resolver un problema o si se ha tomado una decisión específica en un punto del código, se puede añadir un comentario para explicar por qué se ha hecho así y cómo se ha llegado a esa decisión.
  
  
• Utilizar comentarios para documentar el propósito general del proyecto. Esto incluye información como el nombre del proyecto, su autor, la fecha en la que se ha creado y una breve descripción del propósito del proyecto. De esta forma, otros usuarios que utilicen el código podrán entender mejor su propósito y utilizarlo de manera adecuada.

• Utilizar bloques personalizados para organizar el código. Los bloques personalizados permiten agrupar ciertas partes del código en un solo bloque, lo que hace que el código sea más legible y fácil de mantener. Por ejemplo, se podría definir un bloque personalizado que moviera al personaje y modificara una variable, de tal forma que pudiéramos reutilizar ese bloque personalizado las veces que queramos sin tener que duplicar todos los bloques que forman dicha acción:

• Utilizar comentarios para separar los distintos bloques de código. Por ejemplo, insertando comentarios flotantes antes de los bloques que consideremos más importantes, podemos añadir descripciones a grupos de bloques. Podemos hacer esto por cada grupo de bloques que queramos comentar, de manera que nuestro código estará organizado en grupos lógicos y cada grupo tendrá un comentario que explique su función, lo que lo hará más fácil de leer y entender.