VBdocman is een programma voor het automatisch genereren van technische documentatie uit uw Visual Basic bronbestanden met slechts enkele muisklikken. Het ontleedt broncode en maakt automatisch inhoudsopgave, index, onderwerpen, kruisverwijzingen en contextgevoelige hulp. De indeling van uitvoerdocumentatie is volledig configureerbaar per gebruiker. De vooraf gedefinieerde uitvoerindelingen zijn:
HTML Help (*.chm-bestand dat lijkt op MSDN)-
HTML-bestanden (met Java-index en inhoudsopgave)
WinHelp (*.hlp-bestand)
RTF-document
Xml
VBdocman werkt als add-in in MS Visual Basic 6.0. Na een beroep te hebben doen op een eenvoudig dialoogvenster via het hoofdmenu en (in het eenvoudigste geval) op één knop te hebben geklikt, wordt de opgegeven uitvoerdocumentatie gegenereerd. Het maakt automatisch alle interessante links, zoals Past To, Methoden, Gebeurtenissen, Eigenschappen, Gebeurtenissen, inhoudsopgave en index. In grotere projecten alleen dit werk bespaart vele dagen van saai werk. Documentatie kan vervolgens worden bewerkt en aanvullende beschrijving gegeven daar, zoals Zie ook, Voorbeelden links, object, methode, eigenschap of gebeurtenis beschrijving, parameters beschrijving en ga zo maar door. VBdocman maakt het mogelijk om zelfs die beschrijving automatisch toe te voegen door het uit de broncode commentaar uit speciale tags. Het werkt op dezelfde manier als JavaDoc-systeem. Maar, gebruiker is niet gedwongen om opmerkingen handmatig te schrijven, VBdocman voegt het zelf slechts met twee muisklikken. Alle benodigde tags worden toegevoegd en de gebruiker vult vervolgens slechts korte beschrijving aan hen. Daarnaast biedt het geavanceerde gebruiksvriendelijke commentaar editor.
Voordelen:
Consistentie. Als er iets is toegevoegd aan code, bijvoorbeeld een nieuwe methode, wordt deze automatisch weergegeven in nieuw gegenereerde documentatie.
Documentatie in verschillende formaten kan worden gegenereerd door enkele muisklikken. Zo hebt u documentatie in alle ondersteunde formaten in enkele minuten.
Efficiënte communicatie binnen het team, vooral wanneer Source Safe wordt gebruikt. Elke programmeur becommentarieert zijn deel van de code.
versiegeschiedenis
- Versie 2.25 geplaatst op 2005-11-09
Verbeterde uitvoer- en bugfixes.
Programmadetails
Overeenkomst
EULA - Licentieovereenkomst voor eindgebruikers
VBDOCMAN LICENTIEOVEREENKOMST
De VBdocman Add-In is NIET freeware. Dit betekent:
Alle auteursrechten op VBdocman zijn uitsluitend eigendom van de auteur - Peter Macej (HELIXOFT).
Iedereen kan deze software gebruiken tijdens een proefperiode van 14 dagen.
Na deze proefperiode van 14 dagen of minder, als u door wilt gaan
om VBdocman te gebruiken, moet u zich registreren (kopen). Wanneer u VBdocman koopt, wordt u
geregistreerde gebruiker.
Er zijn volgende soorten licenties uitgegeven voor VBdocman:
1. Een licentie voor het gebruik van één computer. De gebruiker koopt ÉÉN licentie
om de VBdocman op één computer te gebruiken.
2. Een licentie voor het gebruik van de site. De gebruiker koopt één GEBRUIKslicentie,
machtiging van het gebruik van VBdocman, door de koper, de kopers
werknemers of geaccrediteerde agenten, op een onbeperkt aantal computers
op dezelfde fysieke locatie. Deze site locatie zou
normaal gesproken worden gedefinieerd als één gebouw, maar kan worden beschouwd als
een aantal gebouwen binnen dezelfde, algemene, geografische
locatie, zoals een industrieterrein of kleine stad.
Eenmaal geregistreerd, krijgt de gebruiker een niet-exclusieve licentie om
VBdocman op evenveel computers als gedefinieerd door de bovenstaande licentievoorwaarden
afhankelijk van het aantal gekochte licenties, voor elk juridisch doel.
U mag niet gebruiken, kopiëren, emuleren, klonen, huren, leasen, verkopen, wijzigen,
decompileren, demonteren, anders reverse engineer, of de overdracht van de
gelicentieerd programma, of een subset van het gelicentieerde programma, behalve als
in deze overeenkomst voorzien. Een dergelijk ongeoorloofd gebruik moet
resulteren in onmiddellijke en automatische beëindiging van deze licentie en kan
strafrechtelijke en/of civiele vervolging.
De VBdocman proefversie, kan vrij worden verspreid,
mits het distributiepakket niet wordt gewijzigd. Geen persoon of
bedrijf kan een vergoeding in rekening brengen voor de distributie van VBdocman zonder
toestemming van de auteur.
Registreren zie VBdocman home site http://www.vbdocman.com
BEPERKTE GARANTIE
Auteur garandeert niet dat de functies in deze software
zal voldoen aan uw eisen of dat de software foutloos zal zijn.
IN GEEN GEVAL ZAL DE AUTEUR AAN U AANSPRAKELIJK ZIJN VOOR EVENTUELE SCHADE, INCLUSIEF EVENTUELE
GEDERFDE WINSTEN, VERLOREN SPAARGELD OF ANDERE INCIDENTELE OF GEVOLGSCHADE
VOORTVLOEIEN UIT HET GEBRUIK OF HET ONVERMOGEN OM DIT PROGRAMMA TE GEBRUIKEN, OF VOOR EEN CLAIM
DOOR EEN ANDERE PARTIJ. HET VOLLEDIGE RISICO VOOR DE RESULTATEN EN PRESTATIES VAN
HET PROGRAMMA EN DE DOCUMENTATIE WORDT DOOR U OVERGENOMEN.
Auteur behoudt de titel van het eigendom van de software. Alle kopieën en
delen van de software, in welke vorm dan ook, behoren tot de auteur die behoudt
alle rechten die niet uitdrukkelijk zijn toegekend.
Het installeren en gebruiken van VBdocman betekent aanvaarding van deze voorwaarden en
voorwaarden van de licentie.
Als u het niet eens bent met de voorwaarden van deze licentie, moet u VBdocman verwijderen
bestanden van uw opslagapparaten en het product niet meer gebruiken.
