在 Web API(.NET 5 Web API)中找不到文件 Xml 注释

Posted

技术标签:

【中文标题】在 Web API(.NET 5 Web API)中找不到文件 Xml 注释【英文标题】:Can not found file Xml comment in Web API(.NET 5 web API) 【发布时间】:2021-08-16 00:33:39 【问题描述】:

这是XML注释文件的代码配置文件路径的图片。

当我在 Azure 中部署时,我遇到了一个问题,它找不到这个 XML 文件

【问题讨论】:

我尝试将 XML 文件添加到 wwwroot 文件夹中,但它也不起作用......有人像我一样遇到这种情况...... 【参考方案1】:

XML cmets 可以通过以下方法启用:

在解决方案资源管理器中右键单击项目并选择编辑 .csproj。 手动将突出显示的行添加到 .csproj 文件中:

<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);

然后就可以读取xml了:

【讨论】:

以上是关于在 Web API(.NET 5 Web API)中找不到文件 Xml 注释的主要内容,如果未能解决你的问题,请参考以下文章

IIS 上的 .Net 5.0 Web API 部署问题

如何从 ASP.net 5 web api 返回文件

ASP.NET Web API教程2.3.5 用Knockout.js创建动态UI

在 ASP.NET Core 5.0 Web API 中实现 DelegatingHandler?

让 .NET 5 Web API 在 IIS 中一直运行

使用 .NET Framework 3.5 在 C# 中调用 Web API