Link to home
Create AccountLog in
Avatar of Espavo
EspavoFlag for South Africa

asked on

Documenting .Net Application

I’ve been tasked with Documenting the Source-Code of an application that I've been working on for the last year (VB.Net in Visual Studio 2010), and I was wondering if someone could please give me a touch of guidance as how best to do it?

I’ve started with a MindMap… which shows all the files (.aspx, etc.) and /folders… and then I’ve added notes to some of them (so far), like:

Default.aspx
  Default page that runs at application start
   • Page_Load()
      Checks for and initiates AutoLogins
   • BuildPage()
      Builds "Static Pages" from the "Pages" table of the DB
   • OnceADay()
      "Cleans" the /temp folder on application run, once a day...
 
The purpose of the document is that in the unlikely event that I get hit by a meteorite, that my partners will be able to take the code, and this document, to another developer, who should then be able to easily figure his/her way through the code to continue with maintenance and development.

1. Is the way I’m doing it “okay”? Or is there a better (more standard) way to do this?
2. Would you by any chance have a document that I could look at as an example?
3. Is there a way to automagically create a document like this from Visual Studio?

Another piece of the document will be to record changes / bug-fixes as and when they occur…

Thanks

Gayo
SOLUTION
Avatar of BuggyCoder
BuggyCoder
Flag of India image

Link to home
membership
Create an account to see this answer
Signing up is free. No credit card required.
Create Account
Avatar of Espavo

ASKER

I think the \\\ only works in C#... :-(

And, I don't have a build-->output option anywhere... :-(
Avatar of Deepak Lakkad
Hi

You can use ''' (3 times ') in vb.net

Also it will generate xml file having same name as your application in your output folder

- Deepak Lakkad
ASKER CERTIFIED SOLUTION
Link to home
membership
Create an account to see this answer
Signing up is free. No credit card required.
Create Account
Avatar of Espavo

ASKER

Thanks Deepak,

That was very helpfull, and, still doesn't give me what I'm after...

From what I've read here my one biggest problem is that I'm working on a website project, so the "cute" compile and create XML doesn't exist... and, the helpfile and XML generated are too technical for what I'm actually after...

I'm guessing that my MindMap may still be the best option...

Gayo
Avatar of Espavo

ASKER

Sorry for not assigning points earlier...
 
Is it possible to give BuggyCoder 100 points as an assist? <please>

Gayo