Plantilla para archivo de cabecera

/***************************************************
*Nombre del módulo:
*
* Copyright 1997 Company as an unpublished work.
* All Rights Reserved.
*
* The information contained herein is confidential
* property of Company. The user, copying, transfer or
* disclosure of such information is prohibited except
* by express written agreement with Company.
*
* Inicialmente escrito el: FECHA INCICIAL por AUTOR.
*
*Descripción del módulo:
* Llenar en detalle la descripción del módulo y su función
***************************************************/
/* Sección de Include
* Add all
#includes here
*
***************************************************/
/* Sección de Define
* Add all
#defines here
*
***************************************************/
/* Sección de funciones prototipo
* Add prototypes for all functions called by this
* module, with the exception of runtime routines.
*
***************************************************/
Características de una función
/**************************************************
* Function name
: TYPE foo(TYPE arg1, TYPE arg2…)
*
returns
: Descripción del valor que retorna
*
arg1
: description
*
arg2
: description
* Created by
: author’s name
* Date created
: date
* Description
: detailed description
* Notes
: restrictions, odd modes
**************************************************/
El nombre de una función se creará de la siguiente manera:
TYPE nombre_modulo__Nombre_funcion (TYPE arg1, TYPE arg2…);
TYPE nombre_modulo__Nombre_funcion (type parameter1 /* comment */
type parameter2 /* comment */);
Forma de Realizar un Comentario
/************************************************
* This comment incorrectly uses right-hand
*
* asterisks
*
************************************************/
The correct form is:
/************************************************
* This comment does not use right-hand
* asterisks
*************************************************/