XML文档注释与接口和实现类（ES） [英] XML Documentation Comments with Interfaces and implementing class(es)

问题描述

我记录的装配使用 XML文档评论，从中的chm 文件将使用创建<一href="http://www.microsoft.com/downloads/details.aspx?familyid=E82EA71D-DA89-42EE-A715-696E3A4873B2&displaylang=en">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?

推荐答案

似乎没有这样的autodocumentation在沙堡任何支持。该沙堡帮助文件生成器虽然实现自定义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网站：

支持包括为   ＆LT; inheritdoc /＆GT;标签，它可以让你   继承基本文档   类型/成员。这是通过执行   一个独立的工具，以便它也可以是   使用其他第三方工具和   构建脚本。此工具提供   超出这些特性发现，在   建立与提供组件   沙塔。

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.

第二次更新：根据这工作项的沙堡支持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文档注释与接口和实现类（ES）的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！