No sourcecode documentation visible in Intellisense from my own class libraries

[Roberto Rocco]

Hello,

Whenever I use methods from my class libraries I don't get any Intellisense support of the source documentation I supplied.
When I use the same code directly instead (i.e. adding the class directly to my project and not using the assembly dll of my class library) then I get Intellisense information of the methods as expected.

Using third party assemblies instead provides me with the intellisense support.

Is there something special I need to do with my assemblies to provide the same support?

My methods are always documented like this:

using MyClassLibrary

/// <summary>
/// Summary for MyMethod
/// </summary>
/// <param name="MyParam"></param>
void MyMethod (int MyParam)
{
}

Any hints?

Many thanks in advance.

Roberto Rocco.

 

[Immo Landwerth]

Hello,

Whenever I use methods from my class libraries I don't get any
Intellisense support of the source documentation I supplied. When I
use the same code directly instead (i.e. adding the class directly to
my project and not using the assembly dll of my class library) then I
get Intellisense information of the methods as expected.

That is because Visual Studio does not use the source files for
IntelliSense but imports the compiled class library in your project
that uses the library.

Using third party assemblies instead provides me with the
intellisense support.

Yes, since third party libraries often provides an xml documentation
file.

E.g.

C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322\mscorlib.dll
C:\WINDOWS\Microsoft.NET\Framework\v1.1.4322\mscorlib.xml

Is there something special I need to do with my assemblies to provide
the same support?

Yes, you have to create an xml documentation file.

Right click your class library in solution explorer and provide a
filename in

Configuration Properties \ Build \ XML Documentation File

Note: The filename must match projectname.xml

 

[Bob Grommes]

Sounds like you might be adding the compiled DLL to your solution instead of the project. If you add the project you'll get basic Intellisense that you're looking for.

--Bob
Hello,

Whenever I use methods from my class libraries I don't get any Intellisense support of the source documentation I supplied.
When I use the same code directly instead (i.e. adding the class directly to my project and not using the assembly dll of my class library) then I get Intellisense information of the methods as expected.

Using third party assemblies instead provides me with the intellisense support.

Is there something special I need to do with my assemblies to provide the same support?

My methods are always documented like this:

using MyClassLibrary

/// <summary>
/// Summary for MyMethod
/// </summary>
/// <param name="MyParam"></param>
void MyMethod (int MyParam)
{
}

Any hints?

Many thanks in advance.

Roberto Rocco.

 

[Roberto Rocco]

Hello Immo,

thanks a lot for your reply. That was exactly the "missing link" I was
looking for!

Now I can see my docs from my assemblies.

Best regards,

Roberto.