Norm As 1

Estilo de programación 1

A diferencia de la sintaxis del lenguaje de programación, que son reglas fijas que obligatoriamente hay que seguir, un estilo de programación está constituido por directrices que ayudan a obtener programas más legibles. Es por esto que, si bien no existen estilos de programación absolutamente correctos o incorrectos, es aconsejable la adopción, de una manera sistemática, de un conjunto de normas para la escritura de programas. Por ello, se proponen aquí algunas normas relativas a la denominación de los elementos de los programas y de la estructuración de éstos.

1.

INDENTACIÓ N

1. Se debe utilizar un único modelo de indentación a lo largo de todo el programa. 2. Los bloque de código (p.e.,dentro de un bucle o el cuerpo de una función) deberán ir indentados. 3. Si un bloque de código está anidado dentro de otro bloque de código, el bloque más interno deberá ir indentado respecto al externo. 4. Para evitar que cuando haya multiples bloques anidados, unos dentro de otros, el código sobrepase la anchura de la página se recomienda que el número de espacios de la indentación no sea excesivo (3 ó 4).

2.

IDENTIFICADORE S

Los identificadores o nombres de los elementos de un programa deben ser coherentes con el significado de la entidades del mundo real que modelan, de tal manera que sean una descripción clara y breve de las mismas.

Constantes con nombre

Se escribirán en mayúsculas, con un prefijo en minúsculas correspondiente a la notación que se explicará más adelante. Si el identificador de la constantes está formado por varias palabras, estas se separaran mediante el carácter subrayado. Ejemplos:

cESPACIO, iMAX_FILAS

Variable s

Se utilizarán letras minúsculas, comenzando cada palabra que componga el identificador con mayúsculas. Se utilizará un breve prefijo en el identificador, que describa la naturaleza de dicho elemento. Identificador:

[Modificador] [DescripciónTipoDato]Nombre Mnemónic Tipo de ------------------------------------------------------------o dato i --c int r float carácter d (real) a arra (ai = array de int, ar = array de double s y float) rg struct string h (registro) f handle fichero

Dpto. de Ingeniería Escuela de Sistemas Superior y Automática de Ingenieros (UPV/EHU)

2

Estilo de programación Mnemónico --------------------------------Modificador u -sh unsigned l short p long g declaración puntero global Ejemplos:

iContador, ucLetra, gliCantidadGrande

Identificadores de tipos definidos por el usuario

Se utilizarán letras minúsculas, comenzando cada palabra que componga el identificador con letras mayúsculas Se utilizará un prefijo en el identificador de acuerdo con la notación descrita anteriormente, comenzado siempre por la letra minúscula t. Ejemplos:

tsCadenas, trgPersonas, trgFechas

Identificadores de funciones y tareas

Se utilizarán letras minúsculas, comenzando cada palabra que componga el identificador con letras mayúsculas. Se utilizará un prefijo en el identificador de acuerdo con la notación descrita anteriormente, comenzado siempre por las letras minúsculas fn_. (para funciones) o t_ (para tareas) Ejemplos:

3.

fni_ContarLetras, fns_PasarAMayusculas, t_Monito fn_MostrarResultados, r

ESTRUCTURA GENERAL DE LAS PARTES DEL PROGRAMA Cada una de las partes del programa comenzará en la primera columna, indentando o sangrando las líneas que componen cada una de las partes del programa. Se separará cada una de las partes o bloques del programa con una línea en blanco. Así mismo, se recomienda dejar un espacio en blanco antes de cada punto y coma ( ; ) utilizado para finalizar las sentencias de un programa.

4.

DOCUMENTACIÓN INTERNA Comentarios generales de los programas

Cada programa debe tener un comentario general, que debe aparecer al comienzo del mismo. En general, este comentario debe contener la siguiente información:

Nombre del programa Ficheros nercesarios:

Ficheros que son necesarios para la compilación del programa (ej. ficheros .h)

Escuela Superior Dpto. de Ingenieros de Ingeniería (UPV/EHU) de Sistemas y Automática

Estilo de programación 3 Descripción :

Un breve resumen de lo que hace el programa y del método que para ello utiliza.

Programadores :Fecha:

El nombre de los programadores La fecha en que fue escrito el programa

Si es relevante, también se indicará la siguiente información: Una breve historia de todas las modificaciones realizadas, indicando el programador que las realizón y el motivo que las causó

Comentarios generales de los subprogramas

Cada subprograma debe tener un comentario general, que debe aparecer cerca del comienzo del mismo. En general, este comentario debe contener la siguiente información:

Descripción :

Un breve resumen de lo que hace el programa y del método que para ello utiliza.

Parámetros:

Descripción de los parámetros que se le pasan y que devuelve

Si es relevante, también se indicará la siguiente información: Condiciones de entrada Condiciones de salida: Enumeración de los subprogramas que utiliza Enumeración de los subprogramas que le utilizan Una breve historia de todas las modificaciones realizadas, indicando el programador que las realizón y el motivo que las causó

5.

BUENAS PRÁCTICAS

Además de todo lo mencionado anteriormente respento al formato del código, intentaremos adquirir buenas costumbres de programación que hagan nuestros programas más fáciles de depurar, aparte de ser legibles y fáciles de entender. Entre estas buenas prácticas muy aconsejables cabe destacar: Uso de variables locales. Se evitará siempre que sea posible (casi siempre lo es) el empleo de variables globales. Definición de nuevos tipos con typedef previamente a la declaración de variables de esos tipos.

Dpto. de Ingeniería Escuela de Sistemas Superior y Automática de Ingenieros (UPV/EHU)