How to use SandCastle for ASP.NET website?

[ssnaik84]

Hello,

I have a ASP.NET website (not web application) source code.
I want to generate its code documentation through any tool.
I checked SandCastle, but, it generates documentation for only ASP.NET web application, I guess. Because, it needs namespaces and in ASP.NET website, we dont have.

I checked GhostDoc also. but, I could not install it, since, I'm using VS 2008 Express edition.

Please let me know, how to proceed.

Thanks in Adv.
Swapnil

[Frinavale]

I started writing an article on how to produce API documentation some time ago but for some reason I never finished it. If you want to check out the unfinished article series that I'm working on then check out Producing .NET Source Code Documentation Part I.

Part II (the really unfinished part) is probably the thing that you're most interested in but....

Sorry, I haven't finished writing it yet ...I couldn't think of a good function example to use for part I...and I never finished part II because I wanted to step everyone through how to install the DocProject but didn't have a clean machine at the time (maybe I'll get to that on the weekend if I have time).

Follow the links to the codeplex project though....I found it was extremely helpful.

Oh wait a sec, a website not a web application...y ou don't have namespaces...hm mmmm this might be a bit of a problem.

-Frinny

[ssnaik84]

Thanks Frinny..
I have already done code documentation for ASP.NET web applications, using SandCastle. But don't know, how it works with ASP.NET websites. :(

[Frinavale]

Did you try DocProject?
You will have to add a new project to your solution...this project's type will be a DocProject. Step through the wizard and point it to the Web Site that is part of the solution etc. Once you've done that build the solution and see what happens....

[ssnaik84]

Frankly speaking, I don't know how to generate XML file for ASP.NET website.
Its project properties does not have the option.

[Frinavale]

Not sure if you will have it in a website...but try right clicking on the solution and choose "properties ". Depending on whether or not the project is C# or VB it changes from here...

I hate website projects...ther e are just so many things that are missing or don't work as I would expect.

Is there a possibility that you could convert the website into a web application?

-Frinny