Asp.Net 2.0 Documentation

[Kevin]

Hi!
How can I generate documentation for my asp.net 2.0 application?

Thanks

 

[Steven Cheng[MSFT]]

Hi Kevin,

For ASP.NET 2.0 web application, it will be a bit different to generate the
document compare to other kinds of projects. By default, the website web
project model does not support generating an central "XML documentation
file"(in its build setting). However, after VS 2005 SP1, there comes a new
web project type "Web Application Project", this project support the VS
2003/ASP.NET 1.1 project model that can help generate central precompiled
assembly and also "XML documentation file". Therefore, if possible, you can
consider using the ASP.NET "web application project" for normal automatic
document generation:

#Automatic Documentation Generation in ASP.NET applications
http://www.beansoftware.com/ASP.NET-Tutorials/Automatic-Documentation-VB.asp
x

There are also some commercial tools for ASP.NET web application documen
generation:

http://www.winnershtriangle.com/w/Products.ASPNETDocumentationTool.asp

http://www.brothersoft.com/web_author/asp.net/asp.net_documentation_tool_438
62.html

BTW, as long as you get XML documentation file, you can generate document
through some DOC generation tools such as NDoc or the SandCastle:

#sandcastle:
http://www.sandcastledocs.com

http://blogs.msdn.com/sandcastle/archive/2006/10/21/documentation-for-asp-ne
t-ajax-beta-1-site-http-ajax-asp-net-docs-using-sandcastle-code-base.aspx

#NDoc for .NET 2.0
http://geekswithblogs.net/marcel/archive/2006/02/21/70287.aspx

Hope this helps some.

Sincerely,

Steven Cheng

Microsoft MSDN Online Support Lead



==================================================

Get notification to my posts through email? Please refer to
http://msdn.microsoft.com/subscriptions/managednewsgroups/default.aspx#notif
ications.



Note: The MSDN Managed Newsgroup support offering is for non-urgent issues
where an initial response from the community or a Microsoft Support
Engineer within 1 business day is acceptable. Please note that each follow
up response may take approximately 2 business days as the support
professional working with you may need further investigation to reach the
most efficient resolution. The offering is not appropriate for situations
that require urgent, real-time or phone-based interactions or complex
project analysis and dump analysis issues. Issues of this nature are best
handled working with a dedicated Microsoft Support Engineer by contacting
Microsoft Customer Support Services (CSS) at
http://msdn.microsoft.com/subscriptions/support/default.aspx.

==================================================


This posting is provided "AS IS" with no warranties, and confers no rights.


--------------------

 

[peter]

Another commercial one that works with web site projects is VSdocman,
http://www.helixoft.com/vsdocman/overview.html

 

[Steven Cheng[MSFT]]

Hi Kevin,

Have you got the problem resolved or does the info in previous reply help
some?

Sincerely,

Steven Cheng

Microsoft MSDN Online Support Lead


This posting is provided "AS IS" with no warranties, and confers no rights.


--------------------

From: (e-mail address removed) (Steven Cheng[MSFT])
Organization: Microsoft
Date: Mon, 12 Nov 2007 03:45:39 GMT
Subject: RE: Asp.Net 2.0 Documentation