VBdocman 2.25

Over VBdocman

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.