How to include XML documentation file in NuGet package built from a project file?

Question

I consider it generally good practice to include the XML documentation file generated by the C# build in NuGet packages alongside the DLLs to provide intellisense documentation for consumers.

However, it's not clear to me how this can be done when building a package using VS 2017's project file format.

Is this possible?

Obviously I could switch over to maintaining a nuspec file but the VS2017 format is very convenient for keeping versions and dependencies all in one place.

Possible duplicate: stackoverflow.com/questions/5205738/…

bytedev
– bytedev

2019-09-30 10:24:03 +00:00
Commented Sep 30, 2019 at 10:24 — bytedev
– bytedev, Commented Sep 30, 2019 at 10:24

Martin Ullrich · Accepted Answer · 2018-02-07 12:44:48Z

82

As long as you set GenerateDocumentationFile in your csproj file like this:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFramework>netstandard2.0</TargetFramework>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>

</Project>

then all the defaults will generate the documentation file at the correct location and it will be included in the NuGet package.

If Visual Studio added DocumentationFile or other elements, you can delete them and replace it with the single GenerateDocumentationFile property.

answered Feb 7, 2018 at 12:44

Martin Ullrich

102k27 gold badges271 silver badges232 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Hrvoje Batrnek Over a year ago

But from what and where is this doc file going to be created? Where is that file/should be, where is the content?

bytedev Over a year ago

You can still use the DocumentationFile element in the csproj to control where you want to output the XML file. Just remember in your .nuspec file to point to the same XML file in your file element.

Bartosz · Accepted Answer · 2019-07-31 21:49:04Z

8

For other people who came in with the same problem - and if the accepted answer does not help...

Make sure that you have set the 'Include XML documentation' setting in the build configuration you are using (not just Debug, as by default)

In Visual Studio:

or in csproj:

 <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>

answered Jul 31, 2019 at 21:49

Bartosz

4,8869 gold badges52 silver badges92 bronze badges

2 Comments

bytedev Over a year ago

If you remove the Condition attribute it will generate the XML file for all build configurations.

David Alan Condit Over a year ago

Oof. I had "XML documentation file" checked for my Debug config, but not my Release config. Guess which config I used for my Azure Devops build pipeline and couldn't figure out why the XML comments file wasn't being included in the built nuget artifact? :p

Collectives™ on Stack Overflow

How to include XML documentation file in NuGet package built from a project file?

2 Answers 2

2 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

2 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related