src.h: Header C e C++

dcl	SRC: File sorgente
dtd	SRC -- Sorgenti
Nome	Il nome del sorgente
Titolo	Il titolo del sorgente
Sistema	Il sistema di appartenenza
Sorgente	Dalla scansione dei files con suffisso h, hpp, inl. Si veda Testata C e C++ per il formato di compilazione.

Normalmente non è particolamente utile produrre una breve descrizione del sorgente.

I link verso comprendono i seguenti dcl:

• Nessuno.

I link da comprendono i seguenti dcl:

• Nessuno.

Questi sorgenti possono comportare la generazione di documenti automatici. I tipi di doumenti generati dipendono ovviamente dai commenti inseriti nei sorgenti, tipicamente:

• daf.btr: Files Btrieve
• daf.bin: Files Sequenziali Binari
• daf.ascii: Files Sequenziali Ascii
• dat.btr: Tracciato Btrieve
• dat.any: Dati Generici
• dat.ascii: Tracciato Fisso Ascii
• dat.bin: Tracciato Fisso Binario
• dat.tag: Tracciato Tagged
• fun.c: Funzione C
• fun.cpp: Metodo di una Classe C++
• fun.c: Macro C
• kon.def: Define
• kon.vsel: Vsel
• kon.enum: Enumerazioni
• kon.alt: Altre Costanti

E utile riportare tutte le principali modifiche effettuate. Si evitano descrizioni troppo lunghe creando piuttosto un link ad un documento di modifica dst.mdf: Modifica.

In fase di migrazione da una procedura esistente si deve procedere a livelli:

• 1° Livello:
• Si verifica il titolo del sorgente.
• Si assegna un sistema default.
• Si scandiscono gli header, v. Scansione Testata degli Header.
• 2° Livello:
• Si documenta il data base inserendo i necessari commenti per generare i documenti daf, dat, kon.
• Si documentano le classi di libreria inserendo i necesari commenti.