Valhalla Legends Forums Archive | General Programming | Documenting a Project

AuthorMessageTime
FrOzeN
For school, in Visual Basic 6 I have to make a program. The project I'll be making will consist of quite an amount of code, and an excessive amount of documentation on how all the code works and what it does. To give a bit of an idea, it'll be using a TCP connection done via the API and will have subclassing to hook the socket and capture the events (such as packets arriving) to be processed accordly, and be all neatly put together in a series of classes.

As I'll be making this project I want a way to document all the changes I make to my code. Usually I just have a text file which I log everything, though, I was wondering what other ways this can be done without having to install other software on the computer that'll be viewing the documentation (if the software can export the documentation to a webpage, pdf file, or something then that'd be fine too).
May 27, 2007, 8:10 AM
iago
The two most common documentation things that I know of are doxygen and javadoc. I'm not sure if doxygen works in the language you're using, and javadoc definitely doesn't.
May 27, 2007, 3:26 PM
squeegee
They teach visual basic 6 in middle school now? What a waste of funding
June 27, 2007, 3:15 AM
Stealth
[quote author=squeegee link=topic=16736.msg170494#msg170494 date=1182914121]
They teach visual basic 6 in middle school now? What a waste of funding
[/quote]

Hardly. Hook 'em while they're young :)
July 9, 2007, 1:03 PM
DDA-TriCk-E
[quote author=Stealth link=topic=16736.msg170856#msg170856 date=1183986198]
[quote author=squeegee link=topic=16736.msg170494#msg170494 date=1182914121]
They teach visual basic 6 in middle school now? What a waste of funding
[/quote]

Hardly. Hook 'em while they're young :)
[/quote]
Sorry for the bump. I believe he means that the coding language is outdated, they should be teaching something more modern and less restrictive.
August 6, 2007, 1:01 PM
rabbit
No, he meant to troll.
August 6, 2007, 2:03 PM
Yegg
I thought 'he' was 'she'?
August 6, 2007, 4:12 PM
rabbit
Whatever.
August 6, 2007, 6:37 PM
Noodlez
Make a PDF.
October 16, 2007, 7:28 AM
FrOzeN
Yeah, that's why I ended up doing. :)
October 18, 2007, 2:59 AM
Hostile
HTML Help :p gives you a windows 98 feeling but its free and easy to figure out. I made the BinaryChat help file with that back when, worked out well.
October 20, 2007, 11:44 AM

Search