PDF de programación - Guía de estilo de C++ (reducida)

GUÍA DE ESTILO DE C++

(REDUCIDA)



Ingeniería Informática



Seminario de Programación
Departamento de Informática

Algoritmos y estructuras de datos



GUÍA DE ESTILO DE C++

1. Introducción__________________________________________________________2
2. Lectura y mantenimiento del código _______________________________________2
2.1. Encapsulación y ocultación de información ____________________________________ 3
2.2. Uso de comentarios _______________________________________________________ 3
2.3. Uso de espacios y líneas en blanco ___________________________________________ 6
2.4. Elección adecuada de identificadores _________________________________________ 7
3. Organización interna___________________________________________________8
3.1. Declaraciones: ___________________________________________________________ 8
3.2. Pares de llaves: { }________________________________________________________ 8
4. Portabilidad y eficiencia ________________________________________________9
4.1. Reglas para mejorar la portabilidad: __________________________________________ 9
4.2. Reglas para mejorar la eficiencia: ___________________________________________ 10
5. Programa ejemplo ____________________________________________________11



1. Introducción

Este documento tiene como finalidad proporcionar un conjunto de reglas que nos ayuden a escribir
programas en C++ con un “buen estilo”. Un código escrito con buen estilo es aquel que tiene las
siguientes propiedades:

- Está organizado.
- Es fácil de leer.
- Es fácil de mantener.
- Es fácil detectar errores en él.
- Es eficiente.

Hay muchos estilos que cumplen estas características. En este documento simplemente vamos a dar
uno de ellos. Este documento es una versión resumida y adaptada de la guía de estilo para C de Juan
José Moreno Moll.

2. Lectura y mantenimiento del código

Los principios de esta sección sirven para aumentar la legibilidad del código y para facilitar su
mantenimiento. Éstos son:

- Organizar programas utilizando técnicas para encapsular y ocultar información.
- Aumentar la legibilidad usando los espacios y líneas en blanco.

2/14

Departamento de Informática / Seminario de programación

Guía de estilo de C++ (reducida)

- Añadir comentarios para ayudar a otras personas a entender el programa.
- Utilizar identificadores que ayuden a entender el programa.

2.1. Encapsulación y ocultación de información
La encapsulación y ocultación de información ayudan a organizar mejor el código y evitan el
acoplamiento entre funciones del código.
La encapsulación permite agrupar elementos afines del programa. Los subprogramas afines se
agrupan en ficheros (unidades), y los datos en grupos lógicos (estructuras de datos).
Ocultación de información: Un subprograma no necesita saber lo siguiente:

- La fuente de los parámetros que se le pasan como entrada.
- Para que servirán sus salidas.
- Qué subprogramas se activaron antes que él.
- Qué subprogramas se activarán después que él.
- Cómo están implementados internamente otros subprogramas.

Para conseguir esto se deben seguir las siguientes reglas:

- No hacer referencia o modificar variables globales (evitar efectos laterales).
- Declarar las variables y tipos como locales a los subprogramas que los utilizan.
- Si queremos evitar cambios indeseados en parámetros, pasarlos por valor.
- Un procedimiento sólo debe modificar los parámetros pasados en su llamada.

2.2. Uso de comentarios
Los comentarios dan información sobre lo que hace el código en el caso que no sea fácil
comprenderlo con una lectura rápida. Se usan para añadir información o para aclarar secciones de
código. No se usan para describir el programa. Por lo tanto no se deben poner comentarios a una sola
instrucción. Los comentarios se añaden en los niveles siguientes:

- Comentario a ficheros: Al comienzo de cada fichero se añade un prólogo del fichero que

explica el propósito del fichero y da otras informaciones.

- Comentarios a subprogramas: Al comienzo de cada subprograma se añade un prólogo del

subprograma que explica el propósito del subprograma.

- Comentarios dentro del código: Estos comentarios se añaden junto a la definición de algunas
variables (las más importantes), para explicar su propósito, y al comienzo de algunas secciones
de código, especialmente complicadas, para explicar que hacen.

Los comentarios se pueden escribir en diferentes estilos dependiendo de su longitud y su propósito.
En cualquier caso seguiremos las siguientes reglas generales:

- Los comentarios en general se escriben en líneas que no contienen código y antes del código

que queremos clarificar. Esta regla se aplica siempre si el comentario tiene más de una línea.

- Sólo en dos casos se permite poner en la misma línea un comentario y una instrucción:
comentarios a una definición de variable, que explica la finalidad de esta variable. Y un
comentario para indicar final de una estructura del lenguaje.

Aquí vamos a describir como hacer comentarios dentro del código. Dentro de este tipo de
comentarios se pueden distinguir:

Universitat de València

3/14



Algoritmos y estructuras de datos

- Comentarios en cajas: Usados para prólogos o para separar secciones.
- Separador de secciones: Son líneas que sirven para separar secciones, funciones, etc.
- Comentarios para bloques grandes: Se usan al comienzo de bloques de código grandes para

describir esa porción de código.

- Comentarios cortos: Se usan para describir datos y casi siempre se escriben en la misma línea

donde se define el dato. También se usan para indicar el final de una estructura.

- Comentarios para bloques pequeños: Se escriben para comentar bloques de instrucciones

pequeños. Se colocan antes del bloque que comentan y a la misma altura de sangrado.

Comentarios en cajas:

Ejemplo: comentario tipo prólogo en una caja:

/*************************************************************/
/* AUTOR: Nombre */
/* */
/* PROPÓSITO: */
/* */
/*************************************************************/

Separador de secciones:

Ejemplo: Separador de secciones.

/**********************************************************/

Comentarios para bloques grandes:

Ejemplo: comentarios para bloques grandes de código.

/*
*
*
*/


Usar para comentarios a más de un bloque de
sentencias.

Comentarios cortos:
En caso de utilizar este tipo de comentario, seguir las siguientes reglas:

- Utilizar uno o más tabuladores para separar la instrucción y el comentario.

- Si aparece más de un comentario en un bloque de código o bloque de datos, todos comienzan y

terminan a la misma altura de tabulación.

Ejemplo: Comentarios en un bloque de datos.

int alu_teoria;
int alu_practicas; // Número de alumnos por grupo prácticas

// Número de alumnos por grupo teoría

Ejemplo: Comentarios al final de una estructura.

for(i = 1; i <= FINAL; i++)
{
while ( !correcto )
{
correcto = false;

4/14

Departamento de Informática / Seminario de programación

Guía de estilo de C++ (reducida)

cout << "\n Introduce dato:";
cin >> dato;
if (dato < 100)
correcto = true;
}; // WHILE
cout << "\n"
}; // FOR

Universitat de València

5/14



Algoritmos y estructuras de datos

Comentarios para bloques pequeños:

Ejemplo:

// Hallamos la nota media de todos los examenes
for(i = 0; i < NUM_ALUMNOS; i++)
suma = suma + nota[i];
media = suma / NUM_ALUMNOS;

2.3. Uso de espacios y líneas en blanco
Los espacios en blanco facilitan la lectura y el mantenimiento de los programas. Los espacios en
blanco que podemos utilizar son: líneas en blanco, carácter espacio, sangrado.

Línea en blanco:
Se utiliza para separar “párrafos” o secciones del código. Cuando leemos un programa entendemos
que un fragmento de código entre dos líneas en blanco forma un conjunto con una cierta relación
lógica.
Veamos como separar secciones o párrafos en el programa:

- Las secciones que forman un programa se separan con al menos una línea en blanco

(declaración de constantes, declaración de variables, programa principal, …).

- Dentro de un subprograma se separan con una línea en blanco las secciones de declaraciones y

el código del subprograma.

- Dentro de un subprograma se separan con una línea en blanco los fragmentos de instrucciones
muy relacionadas entre sí (por ejemplo, conjunto de instrucciones que realizan una operación).

Espacio en blanco:
Los espacios en blanco sirven para facilitar la lectura de los elementos que forman una expresión. Los
espacios en blanco se utilizan en los casos siguientes:

- Las variables y los operadores de una expresión deben estar separados por un elemento en

blanco.

- Las lista de definición de variables, y las listas de parámetros de una función se deben separar

por un espacio en blanco.

Ejemplos:

Espaciado correcto:

Espaciado incorrecto:
Espaciado dentro de una lista de parámetros: concat(s1, s2)

media = suma / cuenta;
media=suma/cuenta;



Sangrado:
El sangrado se utiliza para mostrar la estructura lógica del código. El sangrado óptimo es el formado
por cuatro espacios. Es un compromiso entre una estructuración legible y la posibilidad de que
alguna línea (con varios sangrados) del código supere el ancho de una línea de una hoja de papel o del
monitor.

6/14

Departamento de Informática / Seminario de programación

Guía de estilo