Home All Groups Group Topic Archive Search About

XML Comments in a namespace

Author
10 Sep 2006 4:25 AM
David A. Osborn
From what I am reading it appears to not be possible to put xml comments in
a namespace in VS2005 and have the system generate them in the comment
document at build time.  Does anyone know of a work around for this or a
patch that maybe out?

Author
10 Sep 2006 10:46 AM
Herfried K. Wagner [MVP]
"David A. Osborn" <dosborn***@hotmail.com> schrieb:
> From what I am reading it appears to not be possible to put xml comments
> in a namespace in VS2005 and have the system generate them in the comment
> document at build time.  Does anyone know of a work around for this or a
> patch that maybe out?

The reason for this is that the same namespace can be used in more than one
file and even in more than one assembly.  Tools like NDOC provided a way for
entering namespace documentation information.

--
M S   Herfried K. Wagner
M V P  <URL:http://dotnet.mvps.org/>
V B   <URL:http://dotnet.mvps.org/dotnet/faqs/>
Author
10 Sep 2006 2:14 PM
Peter Macej
You can do this with our VSdocman. When there are multiple comments for
the same namespace in different files, you'll get a warning. You can
also comment root namespace which has no source code declaration.

--
Peter Macej
Helixoft - http://www.helixoft.com
VSdocman - Commenter and generator of class documentation for C#, VB
..NET and ASP .NET code