Guía de estilo de programación en C++ estructurado

declaran las clases; consúltese la sección sobre unidades de traducción), inmediatamente antes de
cada estructura, función, o campo. Son las cabeceras las que serán consultadas por el programador
que utilice el módulo para conocer su interfaz pública.
// rectangulo.h
/**
La estructura que representa a los rectángulos
*/
struct Rectangulo {
/// La información sobre la base del rectángulo
double base;
/// La información sobre la altura del rectángulo
double altura;
};
/**
* Creador de rectángulos
* @param b La base del futuro rectángulo
* @param a La altura del futuro rectángulo
*/
Rectangulo creaRectangulo(double b, double a);
/**
* Calcula el área del rectángulo
* @return El área del rectángulo, según sus lados
*/
double calcularArea(const Rectangulo &r);
// rectangulo.cpp
/*
Implementación del TDA rectángulo.
*/
#include “rectangulo.h”
Rectangulo creaRectangulo(double b, double a)
{
Rectangulo toret;
toret.base = b;
toret.altura = a;
return toret;
}
double calcularArea(const Rectangulo &r)
{
return ( r.base * r.altura );
}
De los parámetros que se pueden utilizar en este tipo de comentarios, destacan @param y
@return. El primero sirve para documentar un parámetro de una función o procedimiento, tal y
como se ve en la función crearRectángulo() del módulo Rectángulo de ejemplo, más arriba. El
segundo sirve para documentar el valor de retorno de una función, tal y como se aprecia en la
función calcularArea() del módulo del mismo ejemplo. Por último, con @see es posible hacer
referencias cruzadas entre funciones y estructuras de datos, por ejemplo.