Verificación del estándar de desarrollo

De ConssaWiki

Contenido 1 Lineamientos generales 2 Elementos verificados 2.1 Estándar 1.0 2.2 Estándar 2.0

Lineamientos generales

• Al realizar una verificación de código, se agrega un comentario en la primera linea del archivo, o se modifica que ya existe. Este comentario indica la fecha en que se verificó el código, la revisión(SVN) o conjunto de cambios (TFS) que se revisó, los elementos que se revisaron, y la persona que lo revisó. Ejemplo:

// código verificado el 14/06/2012, conjunto de cambios 95 por dgavidia (nomenclatura + using + comentarios ///)

// código verificado el 12/06/2012, revision 1151 por dgavidia (nomenclatura + comentarios ///)

• Se verifica el código nuevo o modificado en el sprint.
• Cuando se detecta código que no cumple con el estándar:
  • Si el código corresponde al sprint actual: se le notifica al programador para su corección. Ejemplo:

Frm_AvisoCobro.cs - linea 795 - variable global con nombre no estandar
Frm_AvisoCobro.cs - linea 1043 - método sin comentario 
Frm_AvisoCobro.cs - multiples veces "int i" , variable con nombre no estandar

• • Si el código no corresponde al sprint actual: Se deja un comentario tipo TODO. Ejemplo:

// TODO los parámetros de este método no tienen nombres estándar

Elementos verificados

El estándar contiene muchos elementos, con gran diversidad, que hacen muy compleja su implantación "inmediata". Por eso se realiza una implantación "progresiva" del estándar. La siguiente es una lista de los elementos que se verifican actualmente.

Estándar 1.0

• Nomenclatura
• Comentarios: Las clases o métodos creados 'manualmente' deben ser comentado al principio de este. Utilizando comentarios tipo “///”. De igual forma se deben comentar rutinas complejas. No es necesario comentar de esta forma los métodos generados autmáticamente por Visual Studio que correspondan a eventos.

Estándar 2.0

• Nomenclatura
• Comentarios: Toda clase o método debe ser comentado al principio de este. Utilizando comentarios tipo “///”. De igual forma se deben comentar rutinas complejas.
• Ningún archivo debe tener más de 1000 líneas de código.
• Se deben borrar directivas (using) no usadas (resharper)