ArDoc • DSG

Analisi

REQ cat • nome

Disegno Logico
DSG cat • nome
MAN cat • nome

Disegno Tecnico
DST cat • nome
SYS cat • nome

DAF nome
DAT nome
KON nome

CLA nome
FUN nome

SRC cat • nome

Disegno Utente
DSU cat • nome

JOB nome
UUI nome
RPT nome

Varie
AMM cat • nome
QCL cat • nome
RIS cat • nome

e-mail

Cla -- Classi

Tramite i tag della famiglia @Dat si documentano i dati. Prevede il formato 2. Genera un documento CLA -- Classi. Vi sono diversi tag utilizzabili in funzione del tipo di dati che si vogliono documentare. Vengono riepilogati nella tabella che segue.

CLA -- Tags
Sub-Tag	Parametri	Descrizione
@Cla	Stringa Nome	Systema, nome e descrizione della classe
@Name	Text	Nome della Classe
@Sys	Text	Sistema di appartenenza
@Auth	Text	Autore
@DtIni	Date	Data di creazione della definizione. Se assente prende la data del sorgente.
@DtMod	Date	Data di Modifica. Se assente prende la data di creazione.
@ClaType	token	Tipo di classe. I valori previsti sono: c-module, modulo C o pseudo-classe C. cpp-class, classe C++. perl-module, modulo perl. perl-class.classe perl.
@Parent	dcl.name	Nome della super-classe. E' possibile indicarne pi� di una.
@Descr	Text	Descrizione libera.
@/Descr		Fine descrizione.
	Codice	Il codice che descrive la classe.
@/Cla		Fine Classe

Il codice viene incorporato nel documento.

Esempio di utilizzo di questo tag:

=ardoc
**************************************************************
@Cla    Dtd::Fun :  Gestione Dtd Sorgenti                @/Cla
**************************************************************
@ClaType perl-class
@Descr   
<P>Gestisce il di documenti con dtd Fun, v. #dsg(dtd.Fun).</P>
<P>Gestisce i seguenti campi che appartengono al dtd:</P>
<UL>
    <LI>$dcl, <B>Fun</B>
    <LI>$dtd, <B>Fun</B>
    <LI>$name, nome del documento
    <LI>$title, titolo del documento
    <LI>$system, sistema di appartenenza
    <LI>$class, classe di appartenenza
    <LI>$author, autore del documento
    <LI>$date_composed, data di creazione
    <LI>$date_changed, data di modifica
    <LI>$source_file, path del file sorgente scandito
    <LI>$prototype, prototipo della funzione
    <LI>$define, macro di define
    <LI>$body, descrizone lunga
    <LI>$param_list, lista dei parametri
    <UL>
        <LI>$nome, Nome del parametro
        <LI>$tipo, Tipo (IN, OUT, I/O)
        <LI>$dsc, Descrizione lunga
    </UL>
    <LI>$return_list, lista dei ritorni
    <UL>
        <LI>$valore, Valore ritornato
        <LI>$dsc, Descrizione lunga
    </UL>
</UL>
<P>Gestisce inoltre i seguenti campi che non appartengono al dtd. Questi campi
sono utilizzati a supporto nella scansione dei sorgenti:</P>
<UL>
    <LI>$body_translator, reference al traduttore del body
</UL>
@/Descr
*******************************************************************************************
=cut

Links verso

Disegno Logico
: DTD.CLA • CLA -- Classi
: src.tag2 • Formato 2 dei commenti Tag
: tag.name • Il formato stringa-nome

Links da

Disegno Logico
: src.scan.c • Body dei Sorgenti C
Disegno Utente
: pio.dcl.cla.cpp • cla.cpp: Classe C++