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

时间:2016-11-28 02:50:53

标签: swagger visual-studio-code xml-documentation

我们正在使用Swagger UI文档来描述我们的项目API。 Swagger必须从projectname.xml读取XML以显示所有C.R.U.D.我们在项目中的功能。

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

visual studio xml documentation file

3 个答案:

答案 0 :(得分:4)

以下内容稍微强一些,它不会对框架和项目进行硬编码

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

答案 1 :(得分:3)

请参阅David Waterworth's答案,因为它更强大。

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

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

然后重建你的项目。

答案 2 :(得分:0)

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

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
  <NoWarn>1701;1702;1705;1591</NoWarn>
</PropertyGroup>

(不幸的是,Visual Studio项目属性UI尚未公开启用XML文档文件生成的改进方法。请参见项目系统存储库中的this work itemthis pull request,该方法最初添加了功能。)