|
Code Documenter 1.0.5
|
Email
|
| Submitted on: |
11/4/2004 7:53:35 AM |
| By: |
RobIII
|
| Level: |
Advanced |
| User Rating: |
By 42 Users |
| Compatibility: |
VB 5.0, VB 6.0 |
| Views: |
27248 |
|
|
|
|
|
An application that documents VB5/6 code. Outputs an XML file, which is then transformed with an XSLT into a cool documentation file.
It documents properties, methods, events and even show statistics about your project, references that are used and so on. It really generates a complete overview of your project.
It handles Visual Basic Group files, Project files, modules, forms, classes and is very easy to use (just select the file you want to document and hit the button). It even extract's "TODO","BUG","IDEA" and other 'tags' you might use in your code.
The output is completely configurable with a toolwindow that allows you to filter public/private methods, but also enables you to quickly expand all collapsed nodes in the view and much, much more.
Open Main.vbg and just hit F5 to run the project. Select a visual basic file and see how great it documents. All those expensive commercial tools can now be sent to your trashcan. This is the only tool you'll ever need to document your code.
See screenshot for an example of the output. **NEW** Version 1.0.4 now also recognizes usercontrols, property pages and designer files.
|
 |
| |
|
 Download code
Note: Due to the size or complexity of this submission, the author has submitted it as a .zip file to shorten your download time. Afterdownloading it, you will need a program like Winzip to decompress it.Virus note:All files are scanned once-a-day by Planet Source Code for viruses, but new viruses come
out every day, so no prevention program can catch 100% of them. For your own safety, please:
- Re-scan downloaded files using your personal virus checker before using it.
- NEVER, EVER run compiled files (.exe's, .ocx's, .dll's etc.)--only run source code.
- Scan the source code with Minnow's Project Scanner
If you don't have a virus scanner, you can get one at many places on the net
including:McAfee.com
|
Terms of Agreement:
By using this code, you agree to the following terms...
- You may use
this code in your own programs (and may compile it into a program and distribute it in compiled format for languages that allow it) freely and with no charge.
- You MAY NOT redistribute this code (for example to a web site) without written permission from the original author. Failure to do so is a violation of copyright laws.
- You may link to this code from another website, but ONLY if it is not wrapped in a frame.
- You will abide by any additional copyright restrictions which the author may have placed in the code or code's description.
|
Other 3 submission(s) by this author
|
|
Report Bad Submission
|
Your Vote
|
| |
Other User Comments
|
 11/4/2004 8:37:58 AM: Light Templer
Amazing results! My ***** for.
Needs some more work to handle addins ;)
Crashes on forms without any code.
Regards - LiTe
(If this comment was disrespectful, please report it.)
|
11/4/2004 8:49:52 AM: RobIII
@LiTe: That problem has been fixed now. If you still encounter problems, please let me know (or send me a zipfile with the files that make it crash, so I can see what the problem is)
(If this comment was disrespectful, please report it.)
|
11/4/2004 9:21:44 AM: Light Templer
Fixed and reupload in 12 minutes: Good service ;)))
* The DSR files of an addin (special kind of a class file) are still not recognized.
* Big problems with line counting. In a project with 2538 lines (MZ-Tools) your reports says: 285. Thats less.
^^
LiTe
(If this comment was disrespectful, please report it.)
|
11/4/2004 10:08:51 AM: RobIII
*.Dsr, *.Pag and *.Ctl files are now also recognised.
I don't seem to have a problem with the line counter here? Anyone else got a problem with it? Please let me know!
(If this comment was disrespectful, please report it.)
|
11/4/2004 11:14:07 AM: Light Templer
Works fine now.
With *.CTLs included lines are fine. Differences are on counting empty lines or not.
Suggestions for new features:
* To get a feeling for the quality of a larger project counting comment lines and code lines separated (and calculating the relationship in percent) is a good help.
* Add the last modified date and time to the file names, e.g.:
frmMain (11/4/2004 - 10:13 AM)
frmSaveDlg (11/4/2004 - 11:05 AM)
...
Regards and thx for sharing
LiTe
(If this comment was disrespectful, please report it.)
|
11/4/2004 11:22:06 AM: RobIII
Last modified is a tooltip whenever you hover over a form/class/whatever name (next to it's icon).
It is also visible when you check the checkbox "Show info per project" in the "Tools" panel of the ouput. Make sure you click "GO" after checking it ;-)
Guess you overlooked that?
(If this comment was disrespectful, please report it.)
|
11/4/2004 11:41:27 AM: Kenneth Foster
Rob, very professional looking. Really nice app.The update helped alot as to the .ctls. I'll keep watching too see if more updates are added.
(If this comment was disrespectful, please report it.)
|
11/4/2004 11:43:58 AM: RobIII
Kenneth: Then VOTE dude ;-)
(If this comment was disrespectful, please report it.)
|
11/4/2004 12:57:47 PM: Gandolf_The_GUI
Is this supposed to be an add-in? When I compile the DLL, and try to add it to my add-in list, it says its not a valid VB addin. Any thoughts?
(If this comment was disrespectful, please report it.)
|
11/4/2004 4:48:36 PM: Light Templer
Its a quit normal stand alone app, but you load the .vpg and run.
(If this comment was disrespectful, please report it.)
|
11/4/2004 5:59:15 PM: ACY
WOW - 5G's.
Thanks for sharing. :-)
(If this comment was disrespectful, please report it.)
|
11/4/2004 7:19:53 PM: Daniel W Elkins
Great code, 5 globes.
(If this comment was disrespectful, please report it.)
|
11/4/2004 7:32:54 PM: CodeFester
Nice job and 5 nutz from me for the intersting XSL and XML means used to display what I determine to be relatively useless (although intersting as presented) data. What I mean is it would be much more useful if there were a way to:
1. Export the document as something that is more HTML or that can be pasted into standard word documents (what I am forced to use when documenting a commercial project).
2. Give your app a way to train it to suck flowerbox comments out of the code and use them as descriptions on the methods/properties/events/etc.
3. Allow for adding comments to each method in your app then re-outputting the app complete with new flower boxes containing some generic BS and the comments as descriptions.
4. Do all my work for me so I don't have to! (kidding)
I voted you the 5 nutz mostly because I am really impressed with your knowledge of the whole XSL thing. Good work and thanks for posting it.
(If this comment was disrespectful, please report it.)
|
11/5/2004 3:57:01 AM: Ian Webling
Is this O/S or IE version specific? I get an error 438 on this line:
If colMatches.Count > 0 Then oRoot.setattribute
(If this comment was disrespectful, please report it.)
|
11/5/2004 4:42:50 AM: RobIII
CodeFester: You have the source code, modify it yourself to suit your needs ;-)
Ian Webling: What are you doing? When does it crash? What file? I need more info than this... Is the latest version of XML installed? http://www.microsoft.com/xml
(If this comment was disrespectful, please report it.)
|
11/5/2004 12:22:40 PM:
Nice. Five nuts 4 u
(If this comment was disrespectful, please report it.)
|
11/6/2004 6:48:50 AM: Tom Malone
Very nice! Will be checking back for updates.
(If this comment was disrespectful, please report it.)
|
11/6/2004 8:41:49 AM:
Really nice app. 5 from me, thanks for sharing!
(If this comment was disrespectful, please report it.)
|
11/6/2004 6:22:59 PM: Anders Nissen
Service Pack 2 in Windows XP disables the close/expand functionallity of nodes in the .xml file in Internet Explorer :(
(If this comment was disrespectful, please report it.)
|
11/6/2004 11:14:23 PM: Paul Turcksin
Great stuff. Thanks for sharing. 5 from me.
(If this comment was disrespectful, please report it.)
|
11/7/2004 3:13:03 AM:
I'm setting a runtime error:
Run-time error '-2147467259 (80004005)':
Unable to save character to 'ISO-8859-1' encoding.
(If this comment was disrespectful, please report it.)
|
11/7/2004 7:00:29 PM: RobIII
Anders Nissen: Go to the Menu Tools -> Internet Options -> Tab advanced and enable the first option under security (something with "Enable active content blah blah" or something (my IE is dutch so I'm not sure what it would be called for an EN/US system))
For the user reporting the "Run time error" above this post: Are you using any "weird" characters like é or ë etc? What line does it break in what module/class? Can you give me more info so I can fix it?
People: Make sure that when you report bugs, you leave an Email adres (unlike the user above this post ;-) and tell me WHERE it "crashes" (line number, module/class), WHAT you are trying to do (open what files for example) and all other info that might be of interest. Just reporting a "runtime error xxxx" is not clear enough for me to be able to fix it.
(If this comment was disrespectful, please report it.)
|
11/8/2004 3:10:42 PM: Avi
Greate! Thanks! 5G
(If this comment was disrespectful, please report it.)
|
11/9/2004 4:37:07 AM: Phantom Man
Very Handy And Very Well Written, You Get My 5.
Anders Nissen: Use Mozilla Or Netscape!
Kind Regards
Gary
(If this comment was disrespectful, please report it.)
|
11/12/2004 12:08:26 AM: Masino Sinaga
Winner of the year.. uupss.. winner of the month. Five globes.
(If this comment was disrespectful, please report it.)
|
11/19/2004 1:26:36 PM: Dean Dusenbery
I really like this, 5 from me. There is one small issue. It lists subs/functions etc. that have been commented out, e.g. ' Sub DoSomething will be listed in the function list.
(If this comment was disrespectful, please report it.)
|
11/20/2004 7:32:45 PM: RobIII
@Dean Dusenbery:
That has been fixed in the new 1.0.5 version ;-)
(If this comment was disrespectful, please report it.)
|
3/3/2005 11:29:29 AM: Cymerman
I receive an error:
This operation can not be preformed with a Node Type of Element.
Any Ideas?
Marty
(If this comment was disrespectful, please report it.)
|
3/3/2005 11:30:24 AM: RobIII
What line in which class or module? What type of project are you documenting?
I need more than this...
(If this comment was disrespectful, please report it.)
|
3/31/2005 8:26:57 AM:
When I run your program, when I click
(If this comment was disrespectful, please report it.)
|
3/31/2005 8:29:20 AM:
When I click on 'Document' I get an error 'Error creating object VBScript.ExpReg'
What is wrong?
(If this comment was disrespectful, please report it.)
|
3/31/2005 9:43:00 AM: RobIII
Download and install VBScript 5.6:
http://msdn.microsoft.com/library/default.asp?url=/downloads/list/webdev.asp
(If this comment was disrespectful, please report it.)
|
8/23/2005 10:33:16 AM: Richard
I get the following : "This operation can not be preformed with a Node Type of Element" on the following line of code :"Set oDoc = oGD.DocumentGroup(RemoveFileSpec(txtFile.Text), GetFilePart(txtFile.Text))" for both vbg and vbp. Also : "Object does not support this property or method" on the same line.
Any ideas? E-mail : calamari79@yahoo.com
Thanx
(If this comment was disrespectful, please report it.)
|
8/23/2005 10:51:08 AM: RobIII
@Richard: Take a look at the reply above you...
(If this comment was disrespectful, please report it.)
|
8/24/2005 10:00:10 AM: Richard
I still get the following : "This operation can not be preformed with a Node Type of Element" on the following line of code :"Set oDoc = oGD.DocumentGroup(RemoveFileSpec(txtFile.Text), GetFilePart(txtFile.Text))" for both vbg and vbp. I have downloaded and installled the scripting file and newest XML parser with SDK. Running Windows 2000 - what is wrong? Richard
(If this comment was disrespectful, please report it.)
|
8/24/2005 10:03:35 AM: RobIII
You could ofcourse try to debug it yourself. You DO have, after all, the complete source code. I have no clue what the problem is, I cannot replicate the problem here.
(If this comment was disrespectful, please report it.)
|
9/19/2005 7:51:38 PM: Jim Lewey
Great Job
You're on the right track with this one. This one will be ready for the market without much more work and it should be a good seller.
(If this comment was disrespectful, please report it.)
|
1/29/2006 9:13:42 PM: MTIG
Very nice. 5 globes from me.
(If this comment was disrespectful, please report it.)
|
3/21/2006 12:25:31 PM: c0y0te
Very Very nice peace of code....
Can you please explain hot to use the TODO, BUG and other tags.
5Gs
(If this comment was disrespectful, please report it.)
|
3/22/2006 3:16:55 AM: RobIII
You can put a 'TODO: Blah or a 'BUG: Blah or a 'FIX: Blah or finally an 'IDEA: Blah on a line of code where you replace BLAH with the right info. It will be added to the documentation.
(If this comment was disrespectful, please report it.)
|
Add Your Feedback
Your feedback will be posted below and an email sent to
the author. Please remember that the author was kind enough to
share this with you, so any criticisms must be stated politely, or they
will be deleted. (For feedback not related to this particular code, please
click here instead.)
To post feedback, first please login.
|
