A way to show tooltips for my own classes

[Mike]

Hi.

In VS.NET 2003, when I'm typing a reference to a system class or namespace,
tooltips pop up
giving not only the parameters and variables of methods, but also a short
text descriptions for these methods, classes and namespaces. For
instance, I type System.Diagnostics.Debug.WriteLine, and I see a tooltip
including "Writes a category name and the value of the object's
System.Object.ToString() method...".

My question is, where does VS.NET get these descriptions from, and how do I
enable this for my own classes? I have tried putting my descriptions in
///<summary> comments but this doesn't seem work. I *do* see parameters and
return types tooltips for my classes, but how do I make them show a text
description as well?

Mike

 

[Guest]

Hi Mike

To enable the intellisense for our class XML documentation has to be provided. When the assembly is complied it should be compiled with /doc option which will create the xml documentation file. Place the xml file in the same directory as the assembly.
So, when the assembly is referenced is VS.NET project the xml file will be found and will be used for intelliscense

Refer to the below link for more informatio
<http://msdn.microsoft.com/library/d...html/vcerrDocProcessDocumentationComments.asp

Hope this helps..

Regards
Madh

MVP | MCSD.NE


----- Mike wrote: ----

Hi

In VS.NET 2003, when I'm typing a reference to a system class or namespace
tooltips pop u
giving not only the parameters and variables of methods, but also a shor
text descriptions for these methods, classes and namespaces. Fo
instance, I type System.Diagnostics.Debug.WriteLine, and I see a toolti
including "Writes a category name and the value of the object'
System.Object.ToString() method..."

My question is, where does VS.NET get these descriptions from, and how do
enable this for my own classes? I have tried putting my descriptions i
///<summary> comments but this doesn't seem work. I *do* see parameters an
return types tooltips for my classes, but how do I make them show a tex
description as well

Mik

 

[Mike]

Wow that is fantastic.

Mike

Hi Mike,

To enable the intellisense for our class XML documentation has to be

provided. When the assembly is complied it should be compiled with /doc
option which will create the xml documentation file. Place the xml file in
the same directory as the assembly.

So, when the assembly is referenced is VS.NET project the xml file will be

found and will be used for intelliscense.