Can not found file Xml comment in Web API(.NET 5 web API)

Question

This is a picture of the code config file path of XML comment file.

When I deploy in Azure, I have a problem that It can't find this XML file

I try to add XML file into a wwwroot folder and it's not working too...someones meets this case like me.... — Kelvin
– Kelvin, Commented Aug 16, 2021 at 2:03

Tupac · Accepted Answer · 2021-08-16 02:11:37Z

3

XML comments can be enabled with the following approaches:

Right-click the project in Solution Explorer and select Edit <project_name>.csproj. Manually add the highlighted lines to the .csproj file:

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>$(NoWarn);1591</NoWarn>
</PropertyGroup>





public void ConfigureServices(IServiceCollection services)
    {
         .......//swagger config..
     var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
            var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
            c.IncludeXmlComments(xmlPath);

Then you can read the xml:

answered Aug 16, 2021 at 2:11

Tupac

2,9382 gold badges8 silver badges20 bronze badges

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

Collectives™ on Stack Overflow

Can not found file Xml comment in Web API(.NET 5 web API)

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related