Beruflich Dokumente
Kultur Dokumente
Propósito.
2. Alcance.
3. Organización de archivos.
Convención de nombres.
Prólogo.
Debe indicar lo que hay en el archivo: propósito de los objetos contenidos,
sean éstos funciones, declaraciones de datos externos, definiciones u otros.
La descripción debe ser breve y específica; no debe tomar más trabalo
leerla que la revisión del código.
Inclusiones.
Archivos de encabezados incluídos. Si la inclusión no es obvia, debe
indicarse la razón con un comentario. Los archivos de
inclusión del sistema, como stdio.h, deben preceder los archivos de
inclusióndel usuario.
Definiciones.
Todas las definiciones que afectan todo el archivo.
Definiciones globales.
Declaraciones de datos globales (externos).
Funciones.
Las funciones se colocan al final en el orden más significativo posible.
Archivos de encabezados.
4. Declaraciones de variables.
Recomendación: macros.
Los nombres de macros deben escribirse en mayúsculas. Incluír un comentario en
el mismo renglón de declaración de la macro. Las definiciones de macros deben
estar al principio del archivo, o en un archivo de encabezado. Colocar paréntesis
en torno a los parámetros en el texto de reemplazo, y en torno a todo el texto si es
posible, así:
#define SIGUIENTE(p) ((p)->_next)
5. Funciones.
Declaración de funciones.
6. Comentarios.
en lugar de
estado = EXITO;
i = 0;
while (cadena[i] != NULL) {
transmitCar(cadena[i], &estado);
if (estado != EXITO) break;
}
if (unaCondicion == CIERTO) {
en lugar de
while (cadena[i++] != NULL) {
haceAlgo();
}
es preferible a
if (func())
8. Operadores.
Norma: usar espacios entre operadores binarios.
Todos los operadores que tomen dos parámetros deben tener un espacio antes y
otro después del operador.
9. Espacios en blanco.
10. Constantes.
13. ANSI C.
14. Varios.
15. Conclusión.
16. Referencias.
"C Style and Coding Standards for the SDM Project", Los Alamos
National Laboratory, Univesity of California, 1996.