使用SandCastle生成WCF文档

Question

我正在尝试使用SandCastle为WCF服务生成外部文档.如何告诉SandCastle使用WCF属性,比如ServiceContract命名函数和实体而不是它们在程序集中的名称？

Answer 1

好的，以下内容不会直接回答您的问题，但也许无论如何都会有所帮助。

如果您说要创建“外部服务文档”，那么该外部文档可能并不真正适合 .NET 开发人员，您甚至可能不希望该实现细节（必然）可见。因此，典型的 API 风格文档可能并不适合。

除了 API 样式文档之外，Sandcastle 还支持所谓的“概念文档”。这基本上是“自由文本”，当然是某种 XML 方言。我稍后会回来讨论这个问题。

好的，您首先要为您的服务接口生成一个 WSDL 文件（通常通过附加?WSDL到服务的 URI 或SVCUTIL.EXE在服务程序集中使用，这更适合自动构建）。

然后是最困难的部分。您需要创建一些东西来将 WSDL 转换为MAML文档（我想到的是 XML 样式表）。MAML（微软辅助标记语言）实际上是 Sandcastle 使用的核心格式。

我认为你最好的选择是使用Sandcastle Helpfile Builder从这些文件中创建项目，以创建 CHM、HTML 页面或其他内容。

基本上，一旦您拥有 MAML 文档，您就回到了“标准”Sandcastle 工具链。

我知道这听起来像是一项相当大的工作，而且可能确实如此。我过去做过类似的事情，我会使用 SMO 查询 SQL Server 数据库，为表、过程等生成 MAML 文档，从而生成参考文档。事实上，结果还不错，而且最终的努力也不算太差。

不管怎样，我会继续关注这个问题，以防确实存在“现成的”解决方案:-)