Documenting a Project

[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).

[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.

[squeegee]

They teach visual basic 6 in middle school now? What a waste of funding

[Stealth]

They teach visual basic 6 in middle school now? What a waste of funding

Hardly. Hook 'em while they're young

[Chriso]

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.

[rabbit]

No, he meant to troll.

[Yegg]

I thought 'he' was 'she'?

[rabbit]

Whatever.

[Noodlez]

Make a PDF.

[FrOzeN]

Yeah, that's why I ended up doing.

[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.