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

c# .net xml-documentation
Finglas picture Finglas · Oct 27, 2009 · Viewed 11.5k times · Source 
/// <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.

Answer

Steve Guidi picture Steve Guidi · Oct 27, 2009

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.

Related questions

How to add a line break in C# .NET documentation

This should be waaaay easier... I want to add a "coded" line break to the XML documentation in my code /// <summary> /// Get a human-readable variant of the SQL WHERE statement of the search element. &lt;br/&…

Read More
How to write comments / documentation for variables / fields / lists in VS 2010?

There is ///<summary> ///This is summary for some class or method ///</summary> documentation for classes or methods. But how to write this for simple variables or lists? I use Visual Studio 2010 and when i hover over …

Read More
Summary is not showing in the assembly if it is added as a reference

I've created a 'Class Library' in C#, which has many functions with summary (XML documentation comments). For example ///<summary> ///Adds the two numbres ///</summary> public void Add() { //statements } if i use the function in the same …

Read More