我正在通过网络服务 (.asmx) 公开我的 API。目前，唯一可用的是默认的 WSDL 帮助页面。虽然这非常有帮助，但如果我的目标受众需要更多的帮助，这还不够。例如，假设我想包含一些示例，但仍需要自动生成方法签名等。
是否有一个很好的半自动化（自动方法签名但仍然能够提供示例）来实现这一点？我正在寻找类似this 的东西，它也是可维护的。理想情况下，可以帮助我修改默认 WSDL（我真的很喜欢那个页面）的东西会很棒。 我只需要在部署服务时自动提供文档即可。
有什么建议吗？
【问题讨论】：
标签： c# asp.net .net web-services documentation
也许最简单的方法是使用 XML 文档 cmets。
使用这些注释，您可以自动生成 HTML 文档。例如使用Sandcastle 或NDoc3：
Build Sandcastle Documentation When Building Visual Studio Project
毕竟，您可以将 html 文档自动保存到服务附近的共享位置，并且可以使用浏览器轻松导航到那里。所以，一切都可能接近 - wsdl + html 文档
【讨论】：
这很容易。如果你用三元/// cmets 装饰你所有的类和方法，那么你可以从中生成文档。见这里：
http://msdn.microsoft.com/en-us/library/dd233217.aspx
http://www.developerfusion.com/article/84436/documentation-made-easy-with-c-and-xml/
【讨论】：
同意其他海报，但是我使用 NDoc3 取得了很大的成功。它比 Sandcastle 快很多（这也是一个非常好的工具）。 NDoc3 将创建 .chm、.doc 和 .html 输出。
NDoc3 和 Sandcastle 都生成 MSDN 样式的文档。
【讨论】：