Técnicas de Codificación y Prácticas de Programación

La persona cuyo trabajo y pasión es programar desarrolla con los años sus propias técnicas y prácticas, con las cuales tiene un estandar personalizado que le ayuda a llevar el control de sus proyectos. Es el estilo del programador.

Se pueden encontrar diversas modalidades y metodologías en internet, frecuentemente, si no es para todas están orientadas al trabajo en equipo o equipos de desarrollo grandes, dejando de lado técnicas y prácticas que puedan ser útiles para un desarrollador individual.

A continuación listo algunas técnicas y prácticas que considero personalmente que deben ser tomadas en cuenta:

1. Nombres o nomenclatura:

Debemos colocar nombres descriptivos a las variables, procedimientos o funciones que escribamos. Generalmente el nombre para un procedimiento o función debe indicar la acción que realiza, es decir debe contener un verbo algo así como Listar o Grabar. Si se utilizan clases (deberíamos utilizar clases) los nombres no deberían repetir el nombre de la clase, es decir en vez de ListarLibros en una clase Libro, debería decir Listar. Las variables deberían describir en su nombre lo que almacenan, digamos Promedio o Suma o ValorMáximo. Si son de tipo Boolean debería tener un nombre similar a EsTipo o EsMayor. Y las constantes utilizar guiones bajos tal como FORMATO_FECHA_LARGA.

Respecto de las tablas normalmente le coloco el nombre del item que va a almacenar, en singular (LIBRO, CUENTA, BANCO). Y en las columnas el nombre sin incluir el de la tabla. Para los procedimientos almacenados no utilizar sp_ o sp solo el nombre por ejemplo Libro_Modificar.

Es equivocado ponerle un signo tal como % o & o $ a cualquier objeto sea variable, procedimiento, tabla, etc.

2. Comentarios.

Da flojera documentar. La documentación externa que es para los usuarios y la interna que es para el mismo programador siempre queda al último en las tareas de realizar un sistema. Al menos debemos realizar la interna, que nos ayudará en el futuro a poder realizar modificaciones. La principio de cada formulario, indicando que realiza cada formulario y al inicio de cada procedimiento o función, evitando comentar formularios o funciones para los cuales es obvio la funcionalidad. Tampoco hay que exagerar.

3. Formato.

Utilizar mayúsculas o minúsculas depende de cada uno, yo utilizo mayúsculas para la primera letra del nombre y el resto en minúsculas, excepto para las constantes que todo el nombre está en mayúsculas. En Sql Server sería mejor que los nombres de objetos como tablas, columnas o procedimientos esten en mayúsculas, y cada parte de la sentencia arreglarla para que quepa en una línea.

Los saltos de línea, o indentaciones generalmente son automáticamente realizados por el editor, si no es el caso, hay que hacerlas de tal manera que por la indentación se pueda distinguir entre el inicio de un bucle y el inicio de otro.

4. Programación

Utilizar variables con el tipo de datos adecuado para lo que van a almacenar.
Mantener el alcance de las variables lo mas corto posible. Evitar usar variables globales.
Las variables deben ser creadas con una sola función, para los procedimientso esto también aplica, hay que evitar crear funciones multipropósito.
Evitar tener abierta la conexión a la base de datos mas tiempo del necesario, y usar niveles de seguridad para acceder a ella.
Incluir rutinas de manejo de errores.
En vez de varios IF...THEN utilizar SWITCH o SELECT ...CASE.
Liberar referencias a objetos, explicitamente, no hay que dejarle el trabajo al Windows, sabemos que no es muy confiable.
Para consultas sql, evitar utilizar un SELECT *, indicar que columnas se van a recuperar.
Usar procedimientos almacenados en vez de consultas directas.

Twittear

No te olvides de seguir las actualizaciones de la página en tu Facebook.