/me CBT Code Documenter
Korte omschrijving
Een progje wat ik heb gemaakt om snel alle declaraties en overige interessante info uit mijn VB6 project files te halen.
Lange omschrijving
Dit programma heb ik gemaakt omdat ik altijd vergeet in welke class welke functie ook weer zit, of omdat ik regelmatig het wiel dubbel zit uit te vinden. Het project draait eigenlijk om "CodeDocumenter.dll". Deze DLL bevat 3 classes welke gebruikt worden om VB Group files (*.vbg), VB Project Files (*.vbp) en overige bestanden (*.bas, *.cls, *.frm e.d.) te documenteren.
Ik heb er een test-applicatie om heen geschreven, maar die is (voorlopig) nogal karig. Je kunt een *.vbg of *.vbp openen en het programma poept de documentatie uit.
De "documentatie" is in essentie een XML bestand, welke met behulp van een XSLT wordt gerenderd naar HTML. Na de conversie zal het programma dan ook het XML bestand proberen te openen met je browser. Het meeste werk zat in de XSL welke nogal uitgebreid is geworden.
Waarom heb ik dit geschreven?
Omdat de bestaande tools
of niet doen/deden wat ik wil/wilde
of ze zijn te duur. En zo moeilijk is het nou ook weer niet om te maken. Dus ben ik zelf aan de slag gegaan.
Waar kan ik het downloaden?
Er zijn een paar dingetjes die je moet weten. Het project draait om de DLL. Deze zit in de installer, en eerlijk gezegd zal het me worst wezen wat je er mee doet. Je krijgt alleen niet de source ervan. De DLL is een COM+ DLL en iedere class bevat maar 1 functie, die zichzelf wijst (je roept een methode aan met een pad en een file en that's it).
Heb je VB6 op je systeem staan, of heb je de VB runtime bestanden (SP6) reeds geïnstalleerd dan kun je het bestand zonder runtimes downloaden (336Kb), anders dien je het bestand mét de runtimes te downloaden (3.24Mb).
• [url=http://weg]Code Documenter (No Runtimes) 1.0.3[/url]
• [url=http://weg]Code Documenter (Inc. Runtimes) 1.0.3[/url]
Screenshots
Het programma in actie. Het is érg snel geworden vind ik (hangt natuurlijk ook van je PC af...)
Zo ziet de documentatie er uit (default)
Met het "tools window" kun je een aantal opties aanpassen. Zo wil ik meestal alleen maar Public methodes/properties zien en wil ik alles "expanded" zien.
Zo ziet de "documentatie" er uit. Alle functies/subs/properties enzovoorts worden weergegeven van modMain.
En tot slot, de documentatie van CodeDocumenter.dll

(Alle methodes geven een XML DomDocument terug)
Als de layout of de kleuren van de documentatie je niet aan staan kun je zelf de CSS en XSL aanpassen
Overig 
Totale ontwikkeltijd: Iets minder dan 1 dag.
Besparing: Meerdere dagen per jaar
Disclaimer
Er zitten nog wat kleinigheidjes in de XSL waardoor het "uitklappen" soms wat vreemd doet. Tevens kunnen er nog bugs in zitten (duh). Ik ben dan ook niet aansprakelijk voor eventuele schade bla bla bla...
Je dient overigens wel Internet Explorer 6 (liefst met alle Service Packs) te gebruiken en een redelijk
recente versie van MSXML geïnstalleerd te hebben. Ik heb geen idee of het met andere browsers ook werkt.
Veel plezier ermee!
Update: [rml]RobIII in "[ Alg] Welke tools heb jij voor jezelf ge..."[/rml]
edit:
Oh, en het ding heet
CBT Code Documenter omdat ik bij
Combat werk
en weer een update: 1.0.5
[
Voor 41% gewijzigd door
RobIII op 29-11-2004 09:26
]
There are only two hard problems in distributed systems: 2. Exactly-once delivery 1. Guaranteed order of messages 2. Exactly-once delivery.
Je eigen tweaker.me redirect
Over mij