Visual Studio Code - .net核心 - 生成xml文档

dan*_*man 5 xml-documentation swagger visual-studio-code

我们使用Swagger UI文档来描述我们的项目API.Swagger必须从中读取XML projectname.xml以显示我们在项目中的所有CRUD函数.

问题是当我从Visual Studio切换到Visual Studio代码时,它不会从Visual Studio代码重新生成或更改现有的XML文件.有没有办法在Visual Studio Code中生成XML文档文件,例如在Visual Studio Ultimate中,如下图所示?

visual studio xml文档文件

Dav*_*rth 5

以下稍微更健壮,它没有对框架和项目进行硬编码

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
  <DocumentationFile>bin\Debug\$(TargetFramework)\$(MSBuildProjectName).xml</DocumentationFile>
  <NoWarn>1701;1702;1705;1591</NoWarn>
</PropertyGroup>
Run Code Online (Sandbox Code Playgroud)


Oll*_*lly 5

您可以<GenerateDocumentationFile>在项目文件中使用该属性。这是一个布尔值,并DocumentationFile自动设置属性。

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>1701;1702;1705;1591</NoWarn>
</PropertyGroup>
Run Code Online (Sandbox Code Playgroud)

(不幸的是,Visual Studio 项目属性 UI 尚未公开这种改进的方式来启用 XML 文档文件生成。请参阅项目系统存储库中的此工作项,以及最初添加该功能的此拉取请求。)


cod*_*ape 3

请参阅David Waterworth 的答案,因为它更加稳健。

在项目的 csproj 文件中,添加以下内容。

<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
 <DocumentationFile>bin\Debug\netcoreapp2.0\TodoApi.xml</DocumentationFile>
</PropertyGroup>
Run Code Online (Sandbox Code Playgroud)

然后重建您的项目。