SRC: File sorgente


Questi documenti rappresentano i files sorgenti e i files componenti del sistema.

Concettualmente un sorgente non è un elemento logico del sistema, è piuttosto un elemento fisico e in particolare è un contenitore di funzionalità. Per questo motivo un sorgente può definire tramite gli appositi commenti diversi tipi documenti. Ciò malgrado documentare il sorgente in quanto tale presenta diversi vantaggi:

  • In quanto contenitori i sorgenti sono categorizzati sepatatamente e non dipendono direttamente dai sistemi. La categorizzazione dei sorgenti è automatica e si possono adottare diversi criteri nel costruirla. Uno dei criteri principali è il sistema. Per questo motivo l'assegnazione a ciascun sorgente del sistema default a cui appartiene è comunque un metodo per verificare la mappa dei sistemi.
  • Un implementazione modulare comporta che le funzionalità racchiuse all'interno del sorgente sono in genere omogenee. Ne consegue che pur essendo un contenitore di funzionalità, la documentazione a livello sorgente ha un senso e può essere considerata una documentazione di livello intermedio tra i sistemi e i documenti di dettaglio.
  • Nel caso dei sorgenti relativi a procedure batch, il sorgente rappresenta comunque il luogo ideale dove documentare questo tipo di funzionalità. In parica si tratta di documentare la mainline della procedura.
  • Comunque sia la mappa dei sorgenti è abbastanza facile da produrre. Se ben categorizzata --- cosa che dipende dalla divisione della procedura in sistemi --- questa mappa permette comunque una navigazione all'interno delle funzionalità del sistema.
  • Vi sono diverse forme specializzate di questo documento.

I sorgenti vengono documentati leggendo direttamente il file medesimo. Si veda Tipi di files sorgente per un elenco dei tipi di sorgente gestiti dal sistema di scansione. All'interno di un sorgente è possibile creare dei commenti speciali che a loro volta comportano la creazione di diversi tipi di documenti.

SRC -- Nomi, Note, MSSI, DTD

Nome

Note

name

Nome del sorgente

prop10 - Lista dei Programmi

prop12 - Descrizione del programma

dsg.dcl.src • LastModified: 14-9-2007 • John Peter Arnold