Intellisense (summary/description etc.) missing outside original VS.NET project

[Anders Borum]

Hello!

I have created a C# library with plenty of inline documentation on classes,
methods and so on. The documentation is conforming to Microsofts
recommendations. Here's an example:

// <summary>
// Represents an internal caching mechanism, providing a
// model for caching CmsObjects.
// </summary>
public class CmsCache : CmsObject {}

However, it seems like the documentation is either not included with the C#
library, or I am doing something wrong when compiling (perhaps missing a
setting in VS.NET 2003).

When creating a new project (e.g. a console app) and adding a reference to
the assembly I've created, I don't get the intellisense summary/description
I've added. Is the documentation not included with the assembly?

This is probably a simple question, but I have been looking for this for
quite some time.

Thanks in advance!

 

[Nicholas Paldino [.NET/C# MVP]]

Anders,

In order for your documentation to come up in Intellisense, you need to
go to the project settings and indicate that you want to create XML
documentation. This file should have the same name as your assembly, along
with the ".xml" extension.

Then, place the XML file in the same directory as the assembly, and
VS.NET should pick it up.

Hope this helps.

 

[Anders Borum]

Hello Nicholas

Thanks for the tip. I've written an article about the subject now which has
been published on our intranet. Hopefully this will encourage people to
distribute the documentation with the assemblies

venlig hilsen / with regards
anders borum
--