实现类是否可以从其实现的接口“继承”XML注释？

Question

好奇的问题。我正在使用Microsoft的Sandcastle从我的C＃代码中的XML注释生成文档。我的几个类正在实现已经有注释方法的接口。我宁愿不在接口方法和公共实现方法中复制文档。是否有某种标签我可以用来从界面“继承”这个文档？

Answer 1

此功能目前在Visual Studio中不存在。

您可以获得第三方工具，例如GhostDoc，它将有助于创建XML文档。 GhostDoc还可以选择生成像您尝试的那样“继承”的文档。

链接：GhostDoc

Answer 2

您可以在实现中添加<inheritdoc/>。

您应该看看以下主题：Ways to synchronize interface and implementation comments in C#

Answer 3

如果其他人正在寻找解决方案，我构建了一个库来对XML文档文件进行后处理，以添加对<inheritdoc />标记的支持。

更多信息，请访问www.inheritdoc.io（免费版）。