Question about XML documentation

  • Thread starter Thread starter Gary Morris
  • Start date Start date
G

Gary Morris

Hello, all,

I looked at the other newsgroups, and this one just seems to be
the place to ask. If I'm wrong, let me know. What I'm trying to
do is to use XML comments to create a Summary for each method,
which I have figured out how to do. What I cannot figure out is
how to get them to show up in Object Browser, like the .NET
Framework libraries do. Now, if I just reference a project, I can
see the Summaries fine, make changes and see them updated,
etc. However, once I compile the assembly and reference it, all
of the Summaries are gone. I know about the /doc command line
argument, but I'm thinking that is probably not going to work
mainly because if that's how it has to be done there would be
some really massive XML files for the Framework libraries, and
so far I haven't seen anything like that. So, does anyone know
how this is supposed to work?
 
However, once I compile the assembly and reference it, all
of the Summaries are gone.
Click to expand...

I'm not sure about this but in the project properties in Visual Studio
..NET, you can define an XML documentation file name. Pick the same
name as the assembly and place it in the same directory, and you might
just get lucky. (That's the VS.NET option for the /doc command line
argument, by the way.)
there would be
some really massive XML files for the Framework libraries, and
so far I haven't seen anything like that.
Click to expand...

You just haven't been looking hard enough. :) Look in
Windows\Microsoft.NET\Framework\<version>\, you'll see some huge XML
files along with the DLL assemblies.
 
Christoph Nahr said:
I'm not sure about this but in the project properties in Visual Studio
.NET, you can define an XML documentation file name. Pick the same
name as the assembly and place it in the same directory, and you might
just get lucky. (That's the VS.NET option for the /doc command line
argument, by the way.)


You just haven't been looking hard enough. :) Look in
Windows\Microsoft.NET\Framework\<version>\, you'll see some huge XML
files along with the DLL assemblies.
Click to expand...

Ah, yes, I see them now. I hadn't thought to look there, but it seems
that this must be the proper way to do it. I'll certainly give it a try now.

Thanks a bunch!
 
Back
Top