Nose

Estandarización de código

Tabla de contenido
Variables 2
Estructuras de control 3
Estructuras de bucle 4
Subrutinas y funciones 5
Formularios, controles y clases 6

Variables
Existen diferentes tipo de variables que son ocupados durante el desarrollo de los proyectos y una estructura para la declaración de variables que se puede manejar es la siguiente:
[1 carácter - tipo devariable][mínimo 3 caracteres descriptivos para el nombre de la variable]
Por ejemplo:
sNombreUsuario | Variable tipo string |
iIdUsuario | Variable tipo integer |
cTipoUsuario | Variable tipo char |
dTotalGeneral | Variable tipo decimal |
aValores | Variable tipo array |

En el caso de variables especiales, entiéndase por variables especiales Data Sets, Data Tables, Data Adapters,Conexiones, Command Strings y Querys de Linq se propone la siguiente nomenclatura:
[de 2 a 3 caracteres - tipo de variable][mínimo 3 caracteres descriptivos para el nombre de la variable]
Por ejemplo:
dtInfoDatos | Variable tipo data table |
dsConjuntoDatos | Variable tipo data set |
daListaDatos | Variable tipo data adapter |
conSql | Variable tipo connection |
comSql | Variable tipocommand |
qryLista | Variable tipo query de Linq |

Para el manejo de arrays, lo más conveniente es declarar un arreglo de tipo object independientemente del tipo de datos que se quieran almacenar para no tener problemas durante el almacenamiento de los mismos, y realizar la conversión de los mismos según sea necesario, de la siguiente manera:
Object[] aItemArray = new Object[3] {1, 2, 3};nValor = Converto.ToInt32(aItemArray[0]);

Estructuras de control
Las estructuras de control están basadas en los bloques de código IF-Else y Switch-Case, que quedarían definidos de la siguiente manera:
Estructura IFif(<condición>){#region Caso 1<Bloque de código 1>#endregion}else if(<condición>){#region Caso 2<Bloque de código 2>#endregion}else{#region Caso3<Bloque de código 3>#endregion} | Estructura Switchswitch(<valor a evaluar>){case <valor 1>:#region Caso 1<Bloque de código 1>break;#endregioncase <valor 1>:#region Caso 2<Bloque de código 2>break;#endregiondefult:#region <valor 1><Bloque de código 3>break;#endregion} |

Cabe destacar el uso de las regiones que permiten poder analizar el código de unamanera más sencilla.

Estructuras de bucle
Las estructuras de bucle son aquellas que repiten una cierta función hasta que se cumple una condición o se realiza n número de veces. Dentro de estas encontramos los bloques de código For, ForEach, While y Do-While. Cuyas estructuras están definidas de la siguiente manera:
Estructura Forfor(int nVal=0; nVal<5; nVal++){#region Código arepetir<Bloque de código>#endregion} | Estructura ForEachforeach(DataRow drInfo in dtInfo.Rows){#region Código a repetir<Bloque de código>#endregion} |
Estructura Whilewhile(<Condición>){#region Código a repetir<Bloque de código>#endregion} | Estructura Do-Whiledo{#region Código a repetir<Bloque de código>#endregion}while(<Condición>) |

Para el caso del ciclo For,que está definido por un cierto número de iteraciones, la recomendación principal es no usar las variables que asigna por default, que siempre usa la variable i y en este caso es mejor utilizar la nomenclatura mencionada en la sección de [ Variables ].

Subrutinas y funciones
Aunque las subrutinas y las funciones podrían parecerse en la forma en que se declaran, las finalidades sondiferentes, ya que una subrutina solo realiza una cierta acción y no tiene que regresar ningún valor, pudiendo expresarse de la siguiente forma:
[public/private] void [nombre de la subrutina](<variables>)
Por ejemplo:
/// <summary>
/// Resumen de actividades de la subrutina
/// </summary>
/// <param name=”sValor”>Descripción de la variable</param>
private void...