Explaining property text

[PeterB]

How do you create properties and other class members that are highlighted
with a small explaining text underneath it (and all arguments for methods)
when hover above it or writing in the texteditor?

It works for System-classes, and I think I used to have this on my own
classes (and other source projects I use) as well, but I'm getting old and
have started to forget things ;-) I've added the XML-tags for all
methods/properties i.e. <summary>, but is that only for documentation?

Thanks in advance!

/ Peter

 

[Peter Foot [MVP]]

You have to add the XML comments to your properties/methods etc, you'll also
have to make sure that in the project properties you specify an output name
for the processed xml comments - this should be the same as your dll name
but with xml extension. Then just make sure that when you distribute the dll
you place the corresponding xml file in the same folder. Visual Studio will
find it automatically and fill in the descriptions in the Object Browser,
you call also use a tool like NDoc to compile help files from that xml.

There is a walkthrough of the process here:-
http://www.opennetcf.org/PermaLink.aspx?guid=05650440-2281-4f72-bdb2-fe6343284dca

Peter

 

[PeterB]

Thank you!

You have to add the XML comments to your properties/methods etc, you'll
also have to make sure that in the project properties you specify an
output name for the processed xml comments - this should be the same as
your dll name but with xml extension. Then just make sure that when you
distribute the dll you place the corresponding xml file in the same
folder. Visual Studio will find it automatically and fill in the
descriptions in the Object Browser, you call also use a tool like NDoc to
compile help files from that xml.

There is a walkthrough of the process here:-
http://www.opennetcf.org/PermaLink.aspx?guid=05650440-2281-4f72-bdb2-fe6343284dca

Peter