Buenas Prácticas de Nombramiento en C#

¿Cuáles son las buenas prácticas de nombramiento en C#?

En el desarrollo de software, seguir estándares y buenas prácticas es crucial para crear un código limpio y mantenible. En C#, el nombramiento adecuado de variables, métodos y clases tiene un papel fundamental. Las buenas prácticas de nombramiento no solo mejoran la legibilidad del código, sino que también facilitan la colaboración en equipo.

Nombramiento descriptivo para variables

El primer paso para escribir un código de calidad es utilizar nombres de variables descriptivos. Al declarar variables, es importante que el nombre realmente refleje qué almacena o cuál es su propósito.

Ejemplo de una mala práctica:

DateTime y;

Ejemplo de una buena práctica:

DateTime lastSyncModification;

Estilo PascalCase en métodos

Los métodos deben seguir el estilo PascalCase, comenzando con una letra mayúscula y cada palabra subsecuente también debe iniciar en mayúscula. Además, su nombre debe describir claramente lo que hace el método. Esto facilita comprender qué función se está ejecutando sin tener que leer su implementación.

Ejemplo de una mala práctica:

void getuser() {
    // Implementación
}

Ejemplo de una buena práctica:

void GetActiveUser() {
    // Implementación
}

Nombramiento de clases

Las clases también deben tener nombres claros y descriptivos. Se debe evitar la notación húngara o el uso de números en el nombramiento, ya que el tipo de objeto se deduce de su declaración.

Ejemplo de mala práctica:

public class ClassUser2 {
    // Implementación
}

Ejemplo de buena práctica:

public class CustomUser {
    // Implementación
}

¿Cómo aplicar buenas prácticas en un código existente?

A continuación, mostramos cómo aplicar estas prácticas en un proyecto de C# refactorizando nombres de variables, métodos y clases para hacerlos más descriptivos y legibles.

Renombrar variables

Supongamos que tenemos una variable que simplemente se llama TL. Debe cambiarse para ser más descriptiva.

Mala práctica:

var TL = new List<Task>();

Buena práctica:

var taskList = new List<Task>();

Cambiar nombres de métodos y verificar su función

Si nos encontramos con un método cuyo propósito no está claro por su nombre, por ejemplo showMenu2, debemos cambiarlo a algo más significativo.

Antes del cambio:

void showMenu2() {
    // Código para eliminar una tarea
}

Después del cambio:

void ShowMenuRemoveTask() {
    // Código para eliminar una tarea
}

Ejecución y pruebas

Tras realizar los cambios, es crucial asegurarse de que el código sigue funcionando de manera correcta. Esto se puede hacer construyendo y ejecutando el proyecto.

dotnet build
dotnet run

¿Cuál es el siguiente paso?

Ya has aprendido cómo mejorar la calidad del código a través de buenas prácticas de nombramiento. Tu reto ahora es completar el análisis del código existente, identificar otras oportunidades de mejora y aplicar estos principios.

Ésta es una excelente manera de fortalecer tus habilidades de programación y proporcionar código más limpio, comprensible y mantenible. Sigue adelante y continúa aprendiendo, mejorando y aplicando estas prácticas. ¡Tu próximo paso es explorar conceptos como code smells en la siguiente lección!