Propuesta de Estándar de desarrollo o codificación (Primera Entrega) #programacion

Que es un Estándar de Codificación

Un estándar de codificación completo comprende todos los aspectos de la generación de código. Si bien los programadores deben implementar un estándar de forma prudente, éste debe tender siempre a lo práctico. Un código fuente completo debe reflejar un estilo armonioso, como si un único programador hubiera escrito todo el código de una sola vez. Al comenzar un proyecto de software, es necesario establecer un estándar de codificación para asegurarse de que todos los programadores del proyecto trabajen de forma coordinada. Cuando el proyecto de software incorpore código fuente previo, o bien cuando realice el mantenimiento de un sistema de software creado anteriormente, el estándar de codificación debería establecer cómo operar con la base de código existente.

La legibilidad del código fuente repercute directamente en lo bien que un programador comprende un sistema de software. La mantenibilidad del código es la facilidad con que el sistema de software puede modificarse para añadirle nuevas características, modificar las ya existentes, depurar errores, o mejorar el rendimiento. Aunque la legibilidad y la mantenibilidad son el resultado de muchos factores, una faceta del desarrollo de software en la que todos los programadores influyen especialmente es en la técnica de codificación. El mejor método para asegurarse de que un equipo de programadores mantenga un código de calidad es establecer un estándar de codificación sobre el que se efectuarán luego revisiones del código de rutinas.

Las técnicas de codificación incorporan muchos aspectos del desarrollo del software. Aunque generalmente no afectan a la funcionalidad de la aplicación, sí contribuyen a una mejor compresión del código fuente. En esta fase se tienen en cuenta todos los tipos de código fuente, incluidos los lenguajes de programación, de marcado o de consulta.

En general una técnica de codificación no pretende formar un conjunto inflexible de estándares de codificación. Más bien intenta servir de guía en el desarrollo de un estándar de codificación para un proyecto de software.

Generales

• Para conservar recursos sea muy selectivo en la elección del tipo de dato, asegúrese que el tamaño de una variable no sea excesivamente grande. Por ejemplo en los ciclos for es mejor, en la mayoría de las veces utilizar un tipo de dato tipo short que int.

• Mantenga el tiempo de vida de las variables tan corto como sea posible, esto es muy importante por ejemplo cuando se utiliza un recurso finito como una conexión a una Base de Datos.

• Mantenga el scope de las variables tan corto como sea posible, esto sirve para evitar confusiones, mejorar la mantenibilidad y además minimiza la dependencia, es decir si por algún motivo se comete el error de borrar una variable es más fácil de encontrar el error si esta tiene un scope más pequeño.

• Use los procedimientos y variables con un solo propósito. Evite crear procedimientos multipropósito que lleven a cabo una variedad de funciones no relacionadas.

• Dentro de una clase, evite el uso de variables públicas, en cambio utilice procedimientos y propiedades que accedan a dichas variables (privadas), así provee una capa de encapsulación y brinda la posibilidad de validar valores de cambio sobre las mismas, antes de manipularlas directamente.

• Cuando se trabaje en un entorno web distribuido (aldea web), tenga cuidado de almacenar información en variables de sesión ASP ya que el estado de sesión es almacenado siempre en una sola maquina, considere mejor almacenar dicha información en una base de datos.

• No abra conexiones a datos usando credenciales específicas de usuario, ya que estas no podrán ser reutilizadas por el pool de conexiones.

• Evite el uso de conversión de tipos o casting ya que esto puede generar resultados imprevistos, sobre todo cuando dos variable están involucradas en una sentencia, utilice el cast solo en situaciones triviales, cuando este no sea el caso asegure de comentar la razón por la cual lo hizo.

• Use siempre rutinas de manejo de excepciones

• Sea especifico cuando declare objetos que puedan generar colisión, por ejemplo si tiene dos métodos con el mismo nombre en diferentes namespaces escríbalos con el nombre completo incluyendo el del paquete.

• Evite el uso de variables en el ámbito de aplicación (web).

• Use siempre sentencias Select-Case en lugar de utilizar sentencias if–then repetitivas.

• Siempre que sea posible utilice polimorfismo en vez de cláusulas Select.