Xml comments in intellisense tooltip for dotnet 2.0 assembly
Posted on 2008-06-25
In VS.NET, IntelliSense shows the documentation for [almost] every
system-defined class/method/param. For example: when I'm writing a call to a
method, I see a description of every parameter in a nice tooltip.
I defined a C# class and documented it with XML comments. When I use this
class from code in the *same project*, IntelliSense works fine, and shows my
my XML comments in the tooltips.
But: when I reference the assembly containing my class in another project,
bye-bye XML comments: they just don't show up in the tooltips.
Why? I think I know: it is because the XML comments are not compiled into
the resulting assembly, so they are simply not available to the project
referencing the assembly.
But then: why and how does IntelliSense know what to show in the tooltips
for system classes? (like FileStream, for instance).
How can I build an assembly that, when used by a 3rd party, will be able to
show comments into IntelliSense's tooltips?