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

Fun -- Funzioni

Tramite il tag @Fun si documentano le funzioni. Prevede il formato 3. Genera un documento FUN -- Funzioni.

FUN -- Tags
Sub-Tag	Parametri	Descrizione
@Fun	Stringa Nome	Systema, nome e descrizione della funzione
@Name	Text	Nome della Constante
@Sys	Text	Sistema di appartenenza
@Class	Text	Classe di appartenenza. Alternativo al sistema.
@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.
@Param	name IN\|OUT Text	Parameter description.
@Return	valore text	Description of the return values
@Descr	Text	Descrizione libera.
@/Descr		Fine descrizione.
	Codice	Il codice della funzione fino all'apertura della definizione ('{').

Esempio di utilizzo di questo tag:

/**
*************************************************************************
 @Fun     Convert to long julian
 @Param   jul       IN  The julian date
 @Return  ldtjul        The a long julian date
 @Descr   
 The opposite conversion in not available. It just adds 2,415,019 to 
 the value of #dat(dtjul).
 @/Descr
*************************************************************************
**/
#pragma export(longjul,,32)  
//
ldtjul longjul(dtjul jul)
{
...

Links verso

Disegno Logico
: DTD.FUN • FUN -- Funzioni
: src.tag3 • Formato 3 dei commenti Tag
: tag.name • Il formato stringa-nome

Links da

Disegno Logico
: src.scan.c • Body dei Sorgenti C
: tag • Riepilogo dei Tag
Disegno Utente
: pio.dcl.fun.c • fun.c: Funzione C
: pio.dcl.fun.cpp • fun.cpp: Metodo di una Classe C++