Al escribir nuestro código debemos ser cuidados en la forma en que lo hacemos, algo tan simple como el nombramiento de variables puede afectar el mantenimiento, la escalabilidad y la comprensión del código por parte de tu equipo.
Aquí te dejo la lista de algunos tips importantes.
- Evita utilizar nombres ambiguos aunque estés guardando una variables de manera temporal:
//MAL:
int d;
//BIEN:
int daySinceModification;
2. Evita el uso de nombres genéricos. El nombre de una variable debe decir exactamente para que se utiliza:
//MAL:
var dataFromDb = db.GetFromService().ToList();
//BIEN:
var listOfEmployee = _employeeService.GetEmployees().ToList();
3. Evita utilizar notación húngara o cualquier tipo de inicial para comenzar el nombre:
//MAL:
int iCounter; string strFullName; DateTime dModifiedDate;
//BIEN:
int counter; string fullName; DateTime modifiedDate;
4. Crea las variables justo en el momento que se necesiten. Solamente si tu variables es global y va ser usada en muchos puntos ubícala al principio de tu procedimiento, función o método de lo contrario simple créalas en el momento que la necesites.
5. Se consistente con las mayúsculas y minúsculas y recuerda que C# como otros lenguajes es sensible a esto. Mi recomendación es usar CamelCase para variable locales y PascalCase para propiedades y variables globales, también para constantes.
//MAL:
const int DAYS_IN_WEEK = 7;
const int daysInMonth = 30;
var songs = new List<string> { 'Back In Black', 'Stairway to Heaven', 'Hey Jude' };
var Artists = new List<string> { 'ACDC', 'Led Zeppelin', 'The Beatles' };
bool EraseDatabase() {}
bool Restore_database() {}
class animal {}
class Alpaca {}
//BIEN:
const int DaysInWeek = 7;
const int DaysInMonth = 30;
var songs = new List<string> { 'Back In Black', 'Stairway to Heaven', 'Hey Jude' };
var artists = new List<string> { 'ACDC', 'Led Zeppelin', 'The Beatles' };
bool EraseDatabase() {}
bool RestoreDatabase() {}
class Animal {}
class Alpaca {}
Si quieres aprender más sobre buenas prácticas en C# te recomiendo tomar el curso C# buenas practicas y código limpio:
