c# - 如何在 C# 父类/接口(interface)和子类之间同步 XML 注释

Question

在 Java 中，如果我在父类或接口(interface)上有一个 Javadoc，那么当我将鼠标悬停在子类名称上时，Javadoc 会出现在大多数 IDE 的子类或接口(interface)的上下文中。但是，在带有 C# 的 XML 注释的 Visual Studio 中，这似乎并非如此。有什么方法可以自动同步父类和子类之间的 XML 注释，这样我就不必复制/粘贴它们并手动同步它们了吗？

Answer 1

如果您正在创建一个其他项目将使用的库，那么您可以使用 SandcaSTLe 帮助文件生成器 (SHFB) 的一个很好的选择 <inheritdoc> 标签。虽然 Visual Studio 本身不理解此标记，但 SHFB 提供了一个 IntelliSense Component读取项目生成的 XML 文档文件，并写出一个包含所有 <inheritdoc> 的新 XML 文档文件。由继承的文档替换的标签。这正是我们用于在 NuGet 上为 openstack.net SDK 发送 XML 文档的过程:

1. Create XML documentation during the build.

   

2. Include the IntelliSense Component in our SHFB project.

   

3. 创建一个 .nuspec 文件(NuGet 包规范)explicitly references the XML documentation created by the IntelliSense Component而不是 C# 编译器创建的文档。

在 Visual Studio 中，能够查看基类的文档也是有益的。我用 Inheritance Margin扩展以从重写或实现方法跳转到对其进行完整记录的基类或接口(interface)。