Xml documentation for website

[jmaddrey]

I am trying to require xml comments throughout a website when
building. The website is configured as a site, not a web application
project. I have attempted this using the <compiler> tag with
compilerOptions="/warnaserror /dococumentation.xml". This appears
to be working correctly, failing the build when publicly visible
methods/properties are not commented. However, an error is being
thrown when compiling the global.asax code-behind. A file called
"App_global.asax.gzz-u-m_.0.cs" has public/protected methods without
xml comments. This is a compiler auto-generated file, so I cannot add
comments into this file. Is there a workaround?

Thanks in advance.

 

[Guest]

if you don't have any custom code in the global class, you should be able to
just delete it. Otherwise, one more reason not to use the WebSite project
model IMHO.
You could also try maybe putting global into its own class library in the
same namespace and having your app set a reference to it?
-- Peter
Recursion: see Recursion
site: http://www.eggheadcafe.com
unBlog: http://petesbloggerama.blogspot.com
BlogMetaFinder: http://www.blogmetafinder.com

 

[Peter Macej]

You can try our VSdocman
(http://www.helixoft.com/vsdocman/overview.html). It compiles
global.asax correctly and members don't have to have XML comments. You
can generate XML documentation file or directly MSDN-like documentation.