Buenas practicas en la codificación

Una de las grandes dificultades que se presentan a la hora de trabajar en grupos de desarrollo es el manejo de estándares y buenas costumbres para la codificación, algo que ocurre con mucha frecuencia en proyectos académicos y en proyectos de grupos nuevos. Me ha sucedido en muchas oportunidades como profesor, que a mis alumnos les digo que utilicen la estandarización ECMA(ECMAscript en especial), ya que estoy muy acostumbrado a utilizarla en proyectos de AS y me parecer que es muy ordenada además que es muy fácil de interpretar, después de decirles eso voy a revisar su trabajo y me topo con formatos de codificación rarísimos, ¿qué es lo que pasa? Cuando se tienen muchas clases (hablo de la cátedra) de desarrollo con diferentes lenguajes de programación y diferentes profesores, es muy probable que se adquieran los hábitos de cada profesor, al final se obtiene una mezcla mutante de estándares de codificación que lo único que hace es eliminar la estética del código.

En este caso hablare específicamente del lenguaje AS3, sin embargo estas prácticas son aplicables para cualquier lenguaje de programación.

Recomendaciones:

• Crea un documento donde especifiques la manera de declarar las variables, las funciones, los parámetros, los atributos, encapsulamiento, interfaces, polimorfismo, clases y objetos y compártelos con tu equipo de trabajo.
• Escribe una lista de palabras claves, de verbos que se deben utilizar, de prefijos y sufijos.
• Verbos: maneja solo un verbo para acciones que se repitan pero que deban ser programadas por varios desarrolladores.

consultarEmpleados()

consultarEmpresas()

consultarInventario()

• Sufijos: texto que va después de cada palabra:

_txt – Campos de texto
_btn – Botones
_mc – Clips de película (solo AS)
_lst – Listas
_dg - DataGrids

• Acostúmbrate a definir todas las variables del mismo modo, el nombre de la variable debe decir lo que hace la variable y debe estar sujeta a ciertas condiciones.
• La variable debe empezar en minúscula.
• Si el nombre de la variable es compuesto no puede tener espacio, ejemplo:

numeroPar – Bien
numero par – MAL

• Nota: En el ejemplo anterior la segunda palabra o palabra compuesta de la variable empieza en mayúscula.

• Siempre se debe definir tipos de datos para las variables.
• Sí la variable es numérica intenta iniciarla en 0.
• Las clases (Código) siempre deben iniciar en Mayúscula.

Ejemplo: Conexión, UsuarioDAO.

• Al igual que las variables la palabra compuesta de cada clase debe iniciar en mayúscula.
• Todas las interfaces deben empezar con i mayúscula (I)

Ejemplo: IEstudiante

• Acostúmbrate a escribir el código completo, en especial en condiciones.

Buena costumbre:

If(valor==valorB){

…

}else{

…

}

Mala costumbre:

If valor == valorB

…

else{

…

}

• Cuando puedas elimina redundancias en el código:

o If(valor) – Bien

o If(valor == true) MAL

o En caso de negación: If(!valor) Bien

o If(valor!=true) MAL

• Siempre construye los objetos:

o Var carro:Auto = new Auto(); - Bien

o Var carro:Auto = new Auto; - MAL

• Siempre utiliza punto y coma (;) , optimiza el código, lo hace más rápido y mucho más ordenado.
• Ordena las clases por su NameSpace o Package.

Si quieres encontrar más información esta es la documentación de apoyo para la codificación con AS (repito es aplicable a cualquier otro lenguaje)

Además este documento contiene muy buena información de prácticas con ejemplos en el código.

No te olvides de comentar!