How to generate XML documentation for CSPROJ with multiple targets
One way to fix this is to include the following in each CSPROJ file:
<!-- Build XML documentation for all combinations of target framework x configuration -->
<PropertyGroup>
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml
</DocumentationFile>
</PropertyGroup>
An even better way is to link to a shared configuration file:
<!-- This must come after any other configuration so that it overwrites it -->
<Import Project="$(MSBuildThisFileDirectory)..\Shared.msbuild" />
... and then place the above lines in that shared configuration file where you can also set all the other solution-wide CSPROJ settings like Product
, Company
, Copyright
, ...
An easy way is to set the GenerateDocumentationFile
property to true. The VS UI want to set the path, the MSBuild targets will set this property to true if the path is set or set a default path if the GenerateDocumentationFile
property is true. So you can add this to your csproj file:
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
If you want to set this to true for all your projects to share it, create a file named Directory.Build.props
in your solution's directory with the following content and it will be auto-imported into any projects in the directory hierarchy below:
<Project>
<PropertyGroup>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>
</Project>