Where are my comments???

[Paul Loveless]

Hey all.
I've noticed while programming in C# using vs.net 2003 that my xml comments
(ex. the ///<summary> comments) will not show up in intellisense or the
object browser unless all of the classes are in the same namespace. For
instance, if I create a new winform application that references my class
library, the comments for the classes in the library will not show up when I
view them in the object browser or when I write code that utilizes them
(through auto list members). However, the comments for the microsoft FCL
code still appear. Does anyone know if this is a bug in visual studio or I
am missing an attribute or something? Has anyone else experienced this?

Paul.

 

[Klaus H. Probst]

The XML file that contains the documentation for your library needs to be in
the same directory as the assembly itself (that is, the folder from where
you're referencing it), unless it's in the GAC, in which case IIRC it needs
to be in the framework runtime directory.

Also the name of the XML file itself needs to match the DLL. "MyLib.dll"
will be matched by VS.NET with "MyLib.xml" but not with "My_Lib.xml".

 

[Paul L]

Thanks for the reply. That solved it.

Paul

The XML file that contains the documentation for your library needs to be in
the same directory as the assembly itself (that is, the folder from where
you're referencing it), unless it's in the GAC, in which case IIRC it needs
to be in the framework runtime directory.

Also the name of the XML file itself needs to match the DLL. "MyLib.dll"
will be matched by VS.NET with "MyLib.xml" but not with "My_Lib.xml".


--
Klaus H. Probst, MVP
http://www.vbbox.com/


when

 

[Guest]

Hi Paul L,

I agree with Klaus comments. Just remember to generate your xml file.

If you had not generate it out yet, do this:

Go to your project in the solution explorer. Right click the Project and select properties.

The Property Pages will appear, on the left pane, select Configuration Properties and Build.

Under the outputs section, enter ABC.xml (depends what is your project name) in the XML Documentation File textbox.

Build it, and it will generate the xml file automatically for you.

Good Luck!