Buenas prácticas en C# (Parte 1)

buenas prácticas en c#

Buenas prácticas en C# (Parte 1)

Hola y bienvenidos a un nuevo artículo del blog. Hoy vamos a ver buenas prácticas en C# para Unity, porque un código limpio y manejable es un programador feliz. Este será el primer artículo de tres, hoy veremos hasta el punto 7 (incluido).

 

buenas practicas en c

 

 

Buenas prácticas en C#

Recomendaciones para C#

  1. Usa nombres descriptivos en tus variables (y funciones)
  2. Usa clases de utilidad para tareas comunes
  3. Almacena la información en objetos en lugar de arrays
  4. No abuses de las variables estáticas
  5. Alinea el código con las llaves en vertical
  6. Crea las variables como privadas si no planeas compartirlas
  7. Evita los comentarios innecesarios (si usas bien el punto 1).
  8. Usa Enums
  9. Evita funciones con muchos parámetros. Si es necesario usa un struct.
  10. No silencies los errores (Exception)

 

Bonus: Específicas para Unity

  1. Guarda las referencias necesarias en el Start()
  2. Usa print() en todas partes
  3. No todo son GameObjects
  4. Usa «requiredcomponent»
  5. Update vs FixedUpdate

 

Vamos allá, comenzamos con C#

 

Usa nombres descriptivos en tus variables (y funciones)

x = z * 0.20f;

ó

retencionIRPF = salarioBruto * 0.20f;

un nombre bien pensado ahorra mucho tiempo (y disgustos)

 

Usa clases de utilidad para tareas comunes

Si tienes un código que se repite mucho, no lo copies-pegues en todas partes. Haz una función estática en una clase externa, y llámala.

ejemplo de clase externa con código que se repite

 

Almacena la información en objetos en lugar de arrays

Considera este código. ¿Cuál es más fácil de entender?

buenas prácticas en C#

En el primer caso, los arrays no tienen información asociada al campo. Es decir, si el nombre es la posición 0 o la 2 depende de nosotros (interpretación). En el caso del objeto, lo especifica el nombre del campo.

Además, en el array no podemos mezclar tipos de datos, si necesitamos la edad de la persona podríamos crear un int en la clase persona, en cambio si es un string estamos obligados a guardar la edad como texto.

 

No abuses de las variables estáticas

Una variable estática está presente siempre, lo que puede llevar a hacerlo «todo estático». Esto tiene 2 pegas:

  1. Ese espacio de memoria no se recupera nunca, la variable vive para siempre y siempre está ocupando espacio en memoria.
  2. La variable estática no se inicializa nunca, ni aunque destruyamos el objeto que la contiene. Esto puede provocar problemas de «valores raros» cuando contamos que el objeto es nuevo (debería estar «limpio») pero la variable conserva un valor antiguo.

 

Alinea el código con las llaves en vertical

Una imagen vale más que mil palabras:

 

buenas prácticas en C#

 

Crea las variables como privadas si no planeas compartirlas

Una variable privada nos está diciendo «no se toca!». Normalmente son variables para uso interno, y no tienen información necesaria para nadie más que la propia clase. Por ejemplo:

 

ejemplo de variable privada

 

Evita los comentarios innecesarios (si usas bien el punto 1)

Si los nombres de las variables y funciones son descriptivos, ya explican lo necesario. Es más, demasiados comentarios pueden dificultar la lectura del código.

 

buenas prácticas en C#

 

Y hasta aquí el artículo de hoy, En el siguiente terminaremos los que nos faltan de C#, y en el tercero iremos a por los de Unity.

Feliz semana!

 

Escribe un comentario