miércoles, 30 de diciembre de 2009

Nomenclatura de variables

Las variables de clase siempre empezarán con el prefijo m_ (parece ser que en C# existe la tradición de hacerlo con el prefijo _ , esto debe evitarse puesto que iniciar el nombre de una variable con _ no es CLS Compliant).

Las constantes (aunque se minimizará el uso de estas en favor de Settings de aplicación como se indicará en una norma más adelante) siempre empezarán con el prefijo c_ . También se considerarán constantes a este efecto las variables ReadOnly.

Todas las variables tendrán un nombre que permita entender fácilmente su función en el código, intentando limitar su longitud pero nunca anteponiendo ésta a su comprensión. El objetivo es que se pueda leer el código de una manera lo más humana posible. No se usarán nunca abreviaturas en los nombres.

Está norma también es de aplicación en los bucles, no se usarán variables del estilo i,j,k. En su lugar se usarán  variables que aporten legibilidad al código como index, carItemIndex, etc.

Las variables locales de un método o los parámetros de éste no tendrán nunca ningún prefijo.

Todas las variables se capitalizarán siempre en CamelCase.

Esta norma nos permite visualizar instantáneamente cuando miramos el código de un método si las instrucciones afectan a variables de clase o a variables locales.


Ejemplo de nomenclatura

0 comentarios: