How do you add intelli-sense tool-tip comments to object properties?

[Christopher Kowalski]

If you notice, most Microsoft objects include a comment in the tool-tip that
shows up when using intelli-sense auto-completion that describes that
property or method. How can I add such comments to my own objects?

You'd think that was easy to do, but I just can't figure it out!

Thanks for any help!

Chris

[Peter Koen]

"Christopher Kowalski" <ck****@sympatico.ca> wrote in
news:4O*******************@news20.bellglobal.com:

If you notice, most Microsoft objects include a comment in the
tool-tip that shows up when using intelli-sense auto-completion that
describes that property or method. How can I add such comments to my
own objects?

The intellisense comments are extraced from the xml comments.

///<summary>some description</summary>
///<param name="a">my param description</param>
public void somefunction(int a)
{
}

--
best regards

Peter Koen
-----------------------------------
MCAD, CAI/R, CAI/S, CASE/RS, CAT/RS
http://www.kema.at

[Christopher Kowalski]

Thanks Peter, but that does work for me.

Typing in "///" does bring up the empty XML comments, but if I fill them in,
those comments don't end-up showing-up in the intellisense tooltip when
using that object from another project. Maybe there's some build setting
that required for this to work?

Thanks and regards,

Chris
"Peter Koen" <koen-newsreply&snusnu.at> wrote in message
news:OE**************@TK2MSFTNGP10.phx.gbl...

"Christopher Kowalski" <ck****@sympatico.ca> wrote in
news:4O*******************@news20.bellglobal.com:

If you notice, most Microsoft objects include a comment in the
tool-tip that shows up when using intelli-sense auto-completion that
describes that property or method. How can I add such comments to my
own objects?

The intellisense comments are extraced from the xml comments.

///<summary>some description</summary>
///<param name="a">my param description</param>
public void somefunction(int a)
{
}

--
best regards

Peter Koen
-----------------------------------
MCAD, CAI/R, CAI/S, CASE/RS, CAT/RS
http://www.kema.at

[Peter Koen]

"Christopher Kowalski" <ck****@sympatico.ca> wrote in
news:zt*********************@nnrp1.uunet.ca:

Thanks Peter, but that does work for me.

Typing in "///" does bring up the empty XML comments, but if I fill
them in, those comments don't end-up showing-up in the intellisense
tooltip when using that object from another project. Maybe there's
some build setting that required for this to work?

Thanks and regards,

Chris

I'm not sure, but could be that you have to include the attr.
BrowsableAttribute.

I've used this with custom controls and it always worked perfectly.
--
best regards

Peter Koen
-----------------------------------
MCAD, CAI/R, CAI/S, CASE/RS, CAT/RS
http://www.kema.at

[Ron Allen]

Peter,
Make sure that you have set 'XML Documentation File Path' in the
project's Configuration Properties for the release and debug items. This
will cause the project to build the associated documentation file for
Intellisense.

Ron Allen
"Peter Koen" <koen-newsreply&snusnu.at> wrote in message
news:%2****************@TK2MSFTNGP11.phx.gbl...

"Christopher Kowalski" <ck****@sympatico.ca> wrote in
news:zt*********************@nnrp1.uunet.ca:

Thanks Peter, but that does work for me.

Typing in "///" does bring up the empty XML comments, but if I fill
them in, those comments don't end-up showing-up in the intellisense
tooltip when using that object from another project. Maybe there's
some build setting that required for this to work?

Thanks and regards,

Chris

I'm not sure, but could be that you have to include the attr.
BrowsableAttribute.

I've used this with custom controls and it always worked perfectly.
--
best regards

Peter Koen
-----------------------------------
MCAD, CAI/R, CAI/S, CASE/RS, CAT/RS
http://www.kema.at

[Gabriel Esparza-Romero [MSFT]]

Once you've added the comments change the 'Configuration
Properties->Build->XML Documentation File' project property. The name
should be TheNameOfYourAssembly.xml.

When you add a reference to an assembly, intellisense will look for this
xml file at the same location where the assembly is, if there's such a file
it will copy it to the project's reference directory and it will show the
comments in intellisense.

You should provide your xml file alongside your assembly when doing
development.

--
Gabriel Esparza-Romero, Visual C# Team
This posting is provided "AS IS" with no warranties, and confers no rights.
Use of included script samples are subject to the terms specified at
http://www.microsoft.com/info/cpyright.htm