Visual Studio Code - .net core - 生成 XML 文档说明。

Question

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

问题是当我从Visual Studio切换到Visual Studio Code时，它不能重新生成或更改来自Visual Studio Code的现有XML文件。是否有像Visual Studio Ultimate一样在Visual Studio Code中生成XML文档文件的方法，如下图所示？

- danigitman

---

编写测试而不是自动生成的无人问津或无用的垃圾代码。 - Mitch Wheat

测试很酷，即使如此，我还是想知道一个问题的答案 :) - danigitman

测试远非酷炫之物。但它们可以成为出色的文档。 - Mitch Wheat

Answer 1

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

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

很遗憾，Visual Studio项目属性界面目前还没有暴露这种改进的方式来启用XML文档文件生成。请查看项目系统存储库中的此工作项和此拉取请求，该拉取请求最初添加了此功能。

- Olly

Answer 2

以下内容更加健壮，不会硬编码框架和项目。

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

- David Waterworth

Answer 3

参考David Waterworth的答案，因为它更加健壮可靠。

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

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

然后重新构建您的项目。

- codeape