Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How do you get XML comments to appear in a different project (dll)?

/// <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.

like image 696
Finglas Avatar asked Oct 27 '09 18:10

Finglas


1 Answers

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.
like image 175
Steve Guidi Avatar answered Sep 21 '22 07:09

Steve Guidi