Scansione dei sorgenti


La scansione dei sorgenti permette la generazione della documentazione dall'esame diretto dei file del prodotto. Vi sono diversi vantaggi offerti da questo approccio:

  1. E' relativamente poco costoso creare un inventario aggiornato delle entitā presenti nel sistema. L'onere per lo sviluppatore si limita ad attribuire un titolo alle diverse entitā.
  2. La documentazione di dettaglio č nel codice. Si semplifica l'ggiornamento della documentazione. Si fornisce un supporto alle attivitā di manutenzione.
  3. Il sistema --- con molti limiti --- č in grado di interpretare una parte del codice medesimo. Lo sviluppatore deve scrivere molto meno in quanto documentazione e programma sono integrati.

Il sistema consulta il file parametri e scandisce i sorgenti:

  1. Cerca innanzitutto una testata standard del sorgente. Lo scopo č quello di creare un documento SRC: File sorgente per ciascun file.
  2. Scandisce il corpo del sorgente e cerca i tags che pilotano la generazione di altre entitā. Questi tags devono essere stati predisposti dal programmatore per documentare le diverse entitā presenti nel codice.
  3. Crea i documenti richiesti: classi, funzioni, costanti, tracciati, ecc.
dsg.src • LastModified: 14-9-2007 • John Peter Arnold