Elección de nombres de variables que cumplan las reglas y convenciones
- 6 minutos
Un desarrollador de software una vez dijo: "La parte más difícil del desarrollo de software es asignar nombres a las cosas". No solo el nombre de una variable tiene que seguir ciertas reglas de sintaxis, también debe usarse para que el código sea más legible y comprensible. ¡Eso es mucho pedir una línea de código!
Reglas para nombres de variables
Hay algunas reglas de nomenclatura de variables que aplica el compilador de C#.
- Los nombres de variable pueden contener caracteres alfanuméricos y el carácter de subrayado (_). No se permiten caracteres especiales como el signo de almohadilla
#, de guion-o de dólar$. - Los nombres de variable deben comenzar con una letra alfabética o un carácter de subrayado, no un número. El uso de un carácter de subrayado para iniciar un nombre de variable normalmente se reserva para los campos de instancia privada. Puede encontrar un vínculo para leer más en el resumen del módulo.
- Los nombres de variable NO deben ser una palabra clave de C#. Por ejemplo, no se permitirán estas declaraciones de nombre de variable:
float float;nistring string;. - Los nombres de variables distinguen mayúsculas de minúsculas, lo que significa que
string MyValue;ystring myValue;son dos variables diferentes.
Convenciones para los nombres de variables
Las convenciones son sugerencias acordadas por la comunidad de desarrollo de software. Aunque es libre de decidir no seguir estas convenciones, son tan populares que podrían dificultar que otros desarrolladores comprendan el código. Debe practicar la adopción de estas convenciones y convertirlos en parte de sus propios hábitos de codificación.
- Los nombres de variable deben usar el camel case, un estilo de escritura que utiliza una letra minúscula al inicio de la primera palabra y una letra mayúscula al inicio de cada palabra siguiente. Por ejemplo:
string thisIsCamelCase;. - Los nombres de variable deben ser descriptivos y significativos en la aplicación. Debe elegir un nombre para la variable que representa el tipo de datos que contendrá (no el tipo de datos). Por ejemplo:
bool orderComplete;, NOTbool isComplete;. - Los nombres de variable deben ser una o varias palabras completas anexadas juntas. No use contracciones porque el nombre de la variable puede no estar claro para otros usuarios que lean el código. Por ejemplo:
decimal orderAmount;, NOTdecimal odrAmt;. - Los nombres de variable no deben incluir el tipo de datos de la variable. Es posible que vea algunos consejos para usar un estilo como
string strMyValue;. Fue un estilo popular hace años. Sin embargo, la mayoría de los desarrolladores ya no siguen este consejo y hay buenas razones para no usarla.
El ejemplo string firstName; sigue todas estas reglas y convenciones, suponiendo que desea usar esta variable para almacenar datos que representen el nombre de alguien.
Ejemplos de nombre de variable
Estos son algunos ejemplos de declaraciones de variables (mediante tipos de datos comunes):
char userOption;
int gameScore;
float particlesPerMillion;
bool processedCustomer;
Otras convenciones de nomenclatura
Las reglas y convenciones descritas anteriormente son para variables locales. Una variable local es una variable que tiene como ámbito el cuerpo de un método o una variable en una aplicación de consola que usa instrucciones de nivel superior (como el código de este módulo).
Hay otros tipos de construcciones que puede usar en las aplicaciones y muchas tienen sus propias convenciones. Por ejemplo, las clases se suelen usar en la programación de C# y tienen convenciones asociadas. Aunque no va a crear clases en este módulo, es importante saber que las convenciones de nomenclatura que acaba de aprender sobre caben en un marco de nomenclatura más grande.