Valhalla Legends Archive

Programming => General Programming => Topic started by: FrOzeN on May 27, 2007, 03:10 AM

Title: Documenting a Project
Post by: FrOzeN on May 27, 2007, 03:10 AM
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).
Title: Re: Documenting a Project
Post by: iago on May 27, 2007, 10:26 AM
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.
Title: Re: Documenting a Project
Post by: squeegee on June 26, 2007, 10:15 PM
They teach visual basic 6 in middle school now? What a waste of funding
Title: Re: Documenting a Project
Post by: Stealth on July 09, 2007, 08:03 AM
Quote from: squeegee on June 26, 2007, 10:15 PM
They teach visual basic 6 in middle school now? What a waste of funding

Hardly. Hook 'em while they're young :)
Title: Re: Documenting a Project
Post by: Chriso on August 06, 2007, 08:01 AM
Quote from: Stealth on July 09, 2007, 08:03 AM
Quote from: squeegee on June 26, 2007, 10:15 PM
They teach visual basic 6 in middle school now? What a waste of funding

Hardly. Hook 'em while they're young :)
Sorry for the bump. I believe he means that the coding language is outdated, they should be teaching something more modern and less restrictive.
Title: Re: Documenting a Project
Post by: rabbit on August 06, 2007, 09:03 AM
No, he meant to troll.
Title: Re: Documenting a Project
Post by: Yegg on August 06, 2007, 11:12 AM
I thought 'he' was 'she'?
Title: Re: Documenting a Project
Post by: rabbit on August 06, 2007, 01:37 PM
Whatever.
Title: Re: Documenting a Project
Post by: Noodlez on October 16, 2007, 02:28 AM
Make a PDF.
Title: Re: Documenting a Project
Post by: FrOzeN on October 17, 2007, 09:59 PM
Yeah, that's why I ended up doing. :)
Title: Re: Documenting a Project
Post by: Hostile on October 20, 2007, 06:44 AM
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.