问如何在C#父类/接口和子类之间同步XML注释

EN

如果您正在创建一个其他项目将使用的库，那么您有一个很好的选择，可以使用Sandcastle Help File Builder的标记。虽然Visual Studio本身并不能理解这个标记，但SHFB提供了一个IntelliSense Component来读取项目生成的XML文档文件，并写出一个新的XML文档文件，其中所有的<inheritdoc>标记都被继承的文档所替换。这正是我们在NuGet上发布openstack.net SDK的XML文档时所使用的过程：

1. Create XML documentation during the build.

​

1. Include the IntelliSense Component in our SHFB project.

​

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

在Visual Studio中，能够查看基类的文档也是有益的。我使用Inheritance Margin扩展从覆盖或实现方法跳转到基类或接口，在基类或接口中有完整的文档记录。

Visual Studio不提供开箱即用的功能。无法使它们保持同步，也无法使派生类型继承XML文档。

但是如果您安装了Resharper，它将为您提供将XML注释从基类型复制到派生类型的选项。

​

​

我构建了一个工具来对XML文档文件进行后处理，以添加对标记的支持。

虽然它对源代码中的智能感知没有帮助，但它允许将修改后的XML文档文件包含在NuGet包中，因此可以在引用的NuGet包中使用智能感知。

它在www.inheritdoc.io (免费版本)。