Compilación: Ing. MSc.

Simón Ramos PNFI-UPTAEB Feb’2014

LOS ESTÁNDARES DE PROGRAMACIÓN

El estilo de programación (también llamado estándares de código o

convención de código) es un término que describe convenciones para escribir
código fuente en ciertos lenguajes de programación. 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, se debe establecer un estándar de

codificación para asegurarse de que todos los programadores del proyecto
trabajen de forma coordinada. La legibilidad del código fuente repercute
directamente en lo bien que un programador comprende un sistema de software.
El mantenimiento 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.

Usar técnicas de codificación sólidas y realizar buenas prácticas de

programación con vistas a generar un código de alta calidad es de gran
importancia para la calidad del software y para obtener un buen rendimiento.
Además, si se aplica de forma continua un estándar de codificación bien definido,
se utilizan técnicas de programación apropiadas, y, posteriormente, se efectúan
revisiones de rutinas, caben muchas posibilidades de que un proyecto de software
se convierta en un sistema de software fácil de comprender y de mantener.

Algunos de los estándares a seguir son:

Nombres de variable apropiadas: Una piedra clave para un buen estilo es la

elección apropiada de nombres de la variable, los cuales deben ser
representativos (usar regla mnemotécnica) para facilitar la lectura del código
fuente y su comprensión. De igual manera, los nombres deben estar en
minúsculas, excepto la primera letra de cada palabra a partir de la segunda;
siempre evitando los nombres de variables de un solo carácter (solo usarlo para
variables temporales). Los atributos de la variable (tipo, longitud, entre otros) se
deben ajustar al tipo de dato que almacenarán. Para su declaración se
recomienda seguir siempre la siguiente estructura: <prefijo><nombre>. Por
ejemplo: Txt_Dirección

Constantes: Se deben evitar constantes numéricas sin mucho significado, siendo

conveniente definir las constantes en el programa. Es aconsejable que todos los
caracteres estén en mayúsculas y las palabras separadas por "_" y siguiendo las
mismas convenciones que se usan para variables con respecto a los prefijos para
tipo de dato (p.e. IMax_Empleados). Al momento de programar es recomendable
colocar primero la constante y luego la variable.

Importante: También existen convenciones para los Procedimientos, Funciones,

Clases, Atributos de Clases, Métodos, Paquetes, Controles (para aplicaciones de
tipo visual)
Página: 1
Compilación: Ing. MSc. Simón Ramos PNFI-UPTAEB Feb’2014

Variables globales: Se debe evitar el uso de variables globales ya que pueden

ser modificadas erróneamente y pueden causar errores muy difíciles de identificar.
Si se usan, para poder identificarlas, deben estar en mayúsculas.

Estilo de indentación: La indentación es algo que ayuda a darle claridad a un

programa y es INDISPENSABLE que se haga bien. Debe hacerse con "tabs" y no
con espacios en blanco, siendo lo recomendó un mínimo de cuatro (4) espacios.
En lenguajes de programación que usan llaves ({ }) para indentar o delimitar
bloques lógicos de código, como por ejemplo C, es también un punto clave el buen
estilo. Usando un estilo lógico y consistente hace el código de uno más legible.

Ejemplo: Los corchetes de un bloque if, o switch, o for, deben ir en la misma línea
de la cláusula. A continuación mostramos la forma apropiada de hacerlo.

if ($edadCliente<$edadExigida){
instruccion1;
instruccion2;
} else {
instruccion3;
};
Claridad de los programas: Es importante que los programas y rutinas que se
escriban sean claro y fáciles de entender. Por eso, además de dar la explicación
de que hace cada programa o función al principio, hay que tratar que las funciones
quepan en una sola página y que antes de cada sección se explique qué es lo que
se está haciendo. Sobre todo, cuando se usan "truquitos", es muy importante que
se explique lo que se está haciendo.

Bucles y estructuras de control: El uso de estructuras de control lógicas para

bucles también es parte de un buen estilo de programación. Ayuda a alguien que
esté leyendo el código a entender la secuencia de ejecución.

Espaciado: Los lenguajes de formato libre ignoran frecuentemente los espacios

en blanco. El buen uso del espaciado en la disposición del código de uno es, por
tanto, considerado un buen estilo de programación. En los lenguajes de
programación de la familia C se recomienda también evitar el uso de caracteres
tabulador en medio de una línea, ya que diferentes editores de textos muestran su
anchura de forma diferente.
Cómo No Programar
 Ignorar los mensajes de error que debe emitir la aplicación
 Escribir código sin pensar en lo que hará
 No compilar el código
 No escribir comentarios (documentar) en el código
 Ignorar las normas de programación y presentación
 No usar el depurador y otras herramientas del software
 No pedir ayuda
 Desconocer cómo aislar un problema

Página: 2
Compilación: Ing. MSc. Simón Ramos PNFI-UPTAEB Feb’2014

 Cometer errores de ortografía

 Copiar código de otras aplicaciones, sin comprenderlos
 Nunca dejes el trabajo para el final

¿Por qué hacer comentarios en el código?

Los comentarios deben ser usados para brindar una vista general del
código y proveer información adicional que no está disponible en el propio código.
Los comentarios deberían contener sólo información que es relevante para leer y
entender el programa. Por ejemplo, información acerca de cómo el paquete
correspondiente ha sido desarrollado o en que directorio reside no deben ser
incluidos en los comentarios.
Se considera que los programas tienen tres estilos de comentarios de
implementación: Bloque de Comentarios, Comentarios de una línea, comentarios
finales.

Bloque de Comentarios: Los bloques de comentarios se usan para proporcionar

descripciones de métodos, estructuras de datos y algoritmos. También pueden
usarse en otros lugares, como, dentro de los métodos. Los bloques de
comentarios dentro de una función o método deben estar indentados al mismo
nivel que el código que describen. Un bloque de comentario debe ir precedido por
una línea en blanco para configurar un apartado del resto del código.

/*

* Aquí un bloque de comentarios

*/

Comentarios de una línea: Los comentarios cortos pueden aparecer como una
sola línea indentada al nivel del código que la sigue. Si un comentario no se puede
escribir en una sola línea, debería seguir el formato de los bloques de comentario.
Un comentario de una sola línea debería ir precedido de una línea en blanco. Aquí
tenemos un ejemplo:

int i = 0;

/* Manejando la Condición. */

if (condition) {

...

Página: 3
Compilación: Ing. MSc. Simón Ramos PNFI-UPTAEB Feb’2014

Comentarios finales: El delimitador de comentario // puede comentar una línea

completa o una línea parcial. No debería usarse en líneas consecutivas para
comentar texto; sin embargo, si puede usarse en líneas consecutivas para
comentar secciones de código. Ejemplo:

if (cliente.equals(empleado)) {

...

} else{

return false; //no es un cliente.

Ventajas de Documentar el Código

 La documentación hace más legible un programa.

 Al documentar bien un programa desde un principio se evita que para
cada modificación deba estudiarse profundamente el funcionamiento del
programa, redescubriendo todo lo no documentado, con la ventaja
adicional de que generalmente quién modifica el programa no es
siempre quién lo escribió.
 Facilita la reutilización de módulos y rutinas desde cualquier otro
programa o el mismo.
 Ayuda a determinar cuándo debe ser reescrito un código. Si existen
problemas para explicar el código con un comentario, probablemente el
código esté mal escrito.

Referencias

http://es.wikipedia.org/wiki/Estilo_de_programaci%C3%B3n
http://www.net2client.net/manual/nuevomanual/Estandares_y_normas_de_programacion.htm
http://www.mindmeister.com/es/29206979/est-ndares-de-programaci-n

Página: 4