c# - 模块文档 - XML 文档文件

Question

我正在我的 HDN 学校学习 C# Visual Studio。在 Windows 中，有一种方法可以通过“项目”>“属性”并单击“XML 文档文件”从模块自动生成技术文档。

在 Visual Studio 上 Mac 我没有看到这个功能。

有人可以帮助我吗？它是否存在，或者我应该手动将 /// 写入模块？

Answer 1

您还可以向 .csproj 添加配置，以便在每次构建时生成文档文件。按照这个 SO:

将此代码添加到您的 .csproj 文件

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

或者在你的 repo 的根目录中创建一个 Directory.Build.Props 文件并添加：

<Project>
  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>
</Project>

c# - module documentation - XML documentation file