带有接口和实现类的XML文档注释

Question

我正在使用XML Documentation Comments记录一个程序集,使用Sandcastle从中创建一个chm文件.

我的程序集包含各种接口,每个接口由一个类实现(在我的场景中,这些是WCF服务).

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

Answer 1

Sandcastle 中似乎不支持此类自动文档。Sandcastle帮助文件生成器虽然实现了自定义的heritdoc 标记。

来自 SHFB 网站：

支持 <inheritdoc /> 标记，它允许您从基本类型/成员继承文档。这是通过独立工具实现的，因此它也可以由其他第三方工具和构建脚本使用。该工具提供的功能超出了 Sandcastle 附带的构建组件的功能。

第二次更新：根据此工作项，Sandcastle 对inheritdoc 的“支持”是通过SHFB 工具实现的。我认为最重要的是，SHFB 解决了您的问题。