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