views:

196

answers:

1

Consider:

/// <summary>
/// This method does something...
/// </summary>
public void DoSomething() {
    // code...
}

When using that method/class etc.. in a different dll the comments do not show up.

I've tried a few things - any ideas?

Thanks

+6  A: 

A couple of suggestions:

  • Make sure that your compiler is configured to emit the XML doc comments as part of the compilation job
    • The Microsoft C# compiler switch that controls this is /doc, and can also be configured via the Build property page in a project's settings
  • Make sure that the XML file produced by the compiler matches the name of the DLL (i.e. myAssembly.dll -> myAssembly.xml)
  • When you use the assembly in another project, make sure that the XML file is in the same directory as the DLL being referenced.
Steve Guidi
Smashing - knew it was only something simple. I'd changed my bin folder location (instead of Visual Studio's horrible default location) but not done it for the xml comments. Cheers.
Finglas