如何为 .Net 中的 SOAP/WebService 类生成 HTML 文档？

Question

当您在 VisualStudio(VS) 中启动 WebService 项目时，您实际上会看到一些 HTML 文档，但 C# 注释帮助不会将其传递到 HTML。您可以使用 WebMethod 属性的 Description 属性来获取每个 Web 方法的描述，但这意味着要复制注释帮助中的文本，而且据我所知，也不允许记录 Web 方法参数。

有没有一种简单的方法可以获取 C# 代码中已有的注释帮助？

谢谢你。

Answer 1

我们现在使用 WCFExtra 库将代码中的 XML 注释转换为 WSDL 中的文档注释。

从那里我们使用 TechWriter 来构建文档。

Answer 2

C# 注释不会编译到程序集中。 Codeproject 上有一个用于提供替代 WSDL 文档的解决方案：设置 ASP.NET 应用程序来读取原始 xml 文档文件应该不会太困难，并通过一些配置来将 WSDL 服务和操作与类和方法相匹配。

不过，我不知道是否有任何现成的解决方案可以解决您的问题。

Answer 3

您可以

使用自定义wsdlHelpGenerator

。

我没有测试这个解决方案，但乍一看，如果您基于原始的

DefaultWsdlHelpGenerator.aspx 创建自己的解决方案，它看起来很简单（您可以在 C:\Windows\Microsoft.NET\Framework* 文件夹中找到它） ，就我而言，它是 C:\Windows\Microsoft.NET\Framework 4.0.30319\Config\DefaultWsdlHelpGenerator.aspx)。

您也可以看看这个解决方案：

https://www.codeproject.com/Articles/8483/Externalizing-Web-Service-Documentation