VBdocman 2.25

Circa VBdocman

VBdocman è un programma per la generazione automatica di documentazione tecnica dai file di origine di Visual Basic con pochi clic del mouse. Analizza il codice sorgente e crea automaticamente sommario, indice, argomenti, riferimenti incrociati e guida sensibile al contesto. Il formato della documentazione di output è completamente configurabile dall'utente. I formati di output predefiniti sono: Guida HTML (*.chm file simile a MSDN)- File HTML (con indice Java e sommario) WinHelp (file*.hlp) Documento RTF Xml VBdocman funziona come componente aggiuntivo in MS Visual Basic 6.0. Dopo aver richiamato una semplice finestra di dialogo tramite il menu principale e (nel caso più semplice) facendo clic su un pulsante viene generata la documentazione di output specificata. Crea automaticamente tutti i collegamenti interessanti come Si applica a, Metodi, Eventi, Proprietà, Eventi, Sommario e indice. Nei progetti più grandi solo questo lavoro consente di risparmiare molti giorni di lavoro noioso. La documentazione può quindi essere modificata e viene fornita una descrizione aggiuntiva, ad esempio Vedere anche, Collegamenti esempi, oggetto, metodo, descrizione della proprietà o dell'evento, descrizione dei parametri e così via. VBdocman consente di aggiungere automaticamente anche quella descrizione estraerla dal commento del codice sorgente da tag speciali. Funziona in modo simile al sistema JavaDoc. Ma, l'utente non è costretto a scrivere commenti manualmente, VBdocman lo aggiunge da solo con due clic del mouse. Vengono aggiunti tutti i tag necessari e l'utente riempie solo una breve descrizione. Inoltre, fornisce un sofisticato editor di commenti intuitivo. Vantaggi: Coerenza. Se qualcosa è stato aggiunto al codice, ad esempio un nuovo metodo, si riflette automaticamente nella documentazione appena generata. La documentazione in vari formati può essere generata da pochi clic del mouse. Quindi hai documentazione in tutti i formati supportati in pochi minuti. Comunicazione efficiente all'interno del team, specialmente quando viene utilizzato Source Safe. Ogni programmatore commenta la sua parte di codice.