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.
cronologia delle versioni
- Versione 2.25 pubblicato il 2005-11-09
Uscita avanzata e correzioni di bug.
Dettagli del programma
Eula
Contratto di licenza con l'utente finale
CONTRATTO DI LICENZA VBDOCMAN
Il componente aggiuntivo VBdocman NON è freeware. Ciò significa:
Tutti i diritti d'autore di VBdocman sono di proprietà esclusiva dell'autore - Peter Macej (HELIXOFT).
Chiunque può utilizzare questo software durante un periodo di prova di 14 giorni.
Dopo questo periodo di prova di 14 giorni o meno, se si desidera continuare
per utilizzare VBdocman, è NECESSARIO registrarsi (acquistare). Quando acquisti VBdocman, diventi
utente registrato.
Esistono i seguenti tipi di licenze rilasciate per VBdocman:
1. Una singola licenza DI UTILIZZO del computer. L'utente acquista una licenza
per utilizzare il VBdocman su UN computer.
2. Una licenza SITE USAGE. L'utente acquista una singola licenza USAGE,
che autorizza l'USO di VBdocman, da parte dell'acquirente, degli acquirenti
dipendenti o agenti accreditati, su un numero illimitato di computer
nella stessa posizione fisica del SITO. Questa posizione DEL SITO
normalmente definito come un unico edificio, ma potrebbe essere considerato
essere un certo numero di edifici all'interno della stessa, generale, geografica
come una zona industriale o una piccola città.
Una volta registrato, all'utente viene concessa una licenza non esclusiva per l'utilizzo
VBdocman su tutti i computer definiti dai termini di licenza di cui sopra
in base al numero di licenze acquistate, per qualsiasi scopo legale.
Non è possibile utilizzare, copiare, emulare, clonare, affittare, affittare, vendere, modificare,
decompilare, smontare, altrimenti decodificare o trasferire il
concesso in licenza, o qualsiasi sottoinsieme del programma concesso in licenza, salvo
previsto dal presente accordo. Tale uso non autorizzato deve essere
comportare la cessazione immediata e automatica di questa licenza e può
procedimenti penali e/o civili.
La versione di prova VBdocman, può essere distribuita liberamente,
a condizione che il pacchetto di distribuzione non sia modificato. Nessuna persona o
società può addebitare una tassa per la distribuzione di VBdocman senza
permesso dell'autore.
Per registrarsi vedere VBdocman home site http://www.vbdocman.com
GARANZIA LIMITATA
Author non garantisce che le funzioni contenute in questo software
soddisfare le vostre esigenze o che il software sarà privo di errori.
IN NESSUN CASO L'AUTORE SARÀ RESPONSABILE NEI CONFRONTI DELL'AUTORE PER EVENTUALI DANNI,
PERDITA DI PROFITTI, PERDITA DI RISPARMI O ALTRI DANNI INCIDENTALI O CONSEQUENZIALI
DERIVANTI DALL'USO O DALL'IMPOSSIBILITÀ DI UTILIZZARE QUESTO PROGRAMMA, O PER QUALSIASI RECLAMO
DA QUALSIASI ALTRA PARTE. L'INTERO RISCHIO PER QUANTO RIGUARDA I RISULTATI E LE PRESTAZIONI
IL PROGRAMMA E LA DOCUMENTAZIONE SONO ASSUNTI DALL'UTENTE.
L'autore mantiene il titolo sulla proprietà del software. Tutte le copie e
parti del software, in qualsiasi forma, appartengono all'autore che conserva
tutti i diritti non espressamente concessi.
L'installazione e l'utilizzo di VBdocman significa accettazione di questi termini e
condizioni della licenza.
Se non si è d'accordo con i termini di questa licenza è necessario rimuovere VBdocman
dispositivi di archiviazione e cessare di utilizzare il prodotto.
