How to show XML Comments when using an assembly dll in another project

In the assembly to be redistributed ensure that

VB.Net

Properties > Compile > “Generate XML documentation file” is ticked

Build the project. When copying the dll to the place where you wish to use it, also copy the xml file

 

C#

Properties > Build > Output > “XML documentation file” tick

This may create a lot of warnings.

“Missing XML comment for publicly visible type or member ””

To suppress these XML comment missing warnings, then on same page “Suppress Warnings” add 1591

 

 

One Response to How to show XML Comments when using an assembly dll in another project

  1. Pingback: How to build Help documentation using Sandcastle | Steve Shakespeare

Leave a comment