XML文档评论与接口和实现类 [英] XML Documentation Comments with Interfaces and implementing class(es)

问题描述

我正在使用 XML文档注释记录一个程序集，从其中将使用 chm 文件/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=enrel =noreferrer> Sandcastle 。

I am documenting an assembly using XML Documentation Comments, from which a chm file will be created using Sandcastle.

我的程序集包含各种接口，每个接口都由一个类（在我的场景中是WCF服务）实现。

My assembly contains various interfaces, each of which is implemented by one class (in my scenario these are WCF services).

我已经在界面中添加了文档，有没有方式为我自动记录实现类的相关方法？

I have added documentation to the interfaces, is there any way for me to automatically document the relevant methods on the implementing classes?

推荐答案

似乎没有任何支持这样的自动文档沙堡。 沙堡帮助文件生成器虽然实现了一个自定义的inheritdoc标签。

There seems to not be any support for such autodocumentation in Sandcastle. The Sandcastle Help File Builder though implements a custom inheritdoc tag.

从SHFB网站：

< inheritdoc />标签，它允许
从基础
类型/成员继承文档。这是通过
实现的独立工具，所以它也可以是其他第三方工具和
构建脚本使用的
。此工具提供
以外的
构建组件中提供的
Sandcastle功能。

Support is included for the <inheritdoc /> tag which allows you to inherit documentation from base types/members. This is implemented via a standalone tool so it can also be used by other third-party tools and build scripts. This tool provides features beyond those found in the build component supplied with Sandcastle.

第二次更新：根据此工作项 ，Sandcastle对于inheritdoc的支持是通过SHFB工具。底线我想是，SHFB解决你的问题。

Second Update: according to this workitem, the Sandcastle "support" for inheritdoc is through the SHFB tool. Bottom line I suppose is, SHFB solves your problem.

这篇关于XML文档评论与接口和实现类的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！