c# – 我应该如何为我的Web服务API生成文档？
发布时间：2020-12-15 21:35:43 所属栏目：百科 来源：网络整理
导读：我通过Web服务(.asmx)公开我的API.目前,唯一可用的是默认的WSDL帮助页面.虽然这非常有帮助,但如果我的目标受众需要更多的手持,这还不够.例如,让我们说我想要包含一些示例,但仍需要自动生成方法签名等. 是否有良好的半自动化(自动方法签名,但仍能提供示例)来
|
我通过Web服务(.asmx)公开我的API.目前,唯一可用的是默认的WSDL帮助页面.虽然这非常有帮助,但如果我的目标受众需要更多的手持,这还不够.例如,让我们说我想要包含一些示例,但仍需要自动生成方法签名等.
是否有良好的半自动化(自动方法签名,但仍能提供示例)来实现这一目标？我正在寻找像this这样的东西,它也是可维护的.理想情况下,帮助我修改默认WSDL(我真的很喜欢那个页面)会很棒.我所需要的只是在部署文档时自动提供文档. 有什么建议？ 解决方法
也许最简单的方法是使用XML文档注释.
XML Documentation Comments 使用这些注释,您可以自动生成HTML文档.例如,使用Sandcastle或NDoc3： Build Sandcastle Documentation When Building Visual Studio Project 毕竟,您可以自动将html文档保存到服务附近的共享位置,并且可以使用浏览器轻松导航到该位置.所以,所有可能都接近 – wsdl html文档 （编辑：李大同） 【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容! |