No XML comments message displayed

This page describes what to do in the event a no xml comments message is displayed in the application.

You may be presented with the following message in the desktop application, or not see the comments in the exported content.

To resolve this issue, first verify that the XML comments are being generated. This can be checked via the properties dialogue in visual studio.

This will need to be set for all build configurations you are using.

Alternatively, you can use the GenerateDocumentationFile element in the new project files. This will ensure that the documentation file will be produced for all build configurations and publish activities.

<PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>netcoreapp2.2</TargetFramework>
    <GenerateAssemblyInfo>false</GenerateAssemblyInfo>
    <StartupObject>TheBoxSoftware.Exporter.Program</StartupObject>
    <AssemblyName>exporter</AssemblyName>
    <RootNamespace>TheBoxSoftware.Exporter</RootNamespace>
    <RuntimeIdentifier>win-x64</RuntimeIdentifier>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>