我应该如何为我的 Web 服务 API 生成文档

本文关键字：API 文档 服务 Web 我的 我应该 | 更新日期: 2023-09-27 18:37:09

我正在通过网络服务（.asmx）公开我的API。目前，唯一可用的是默认的 WSDL 帮助页面。虽然这非常有帮助，但如果我的目标受众需要更多的手把手，这是不够的。例如，假设我想包含一些示例，但仍需要自动生成方法签名等。

是否有一个好的半自动（自动方法签名，但仍能够提供示例）来实现这一点？我正在寻找这样的东西，这也是可维护的。理想情况下，可以帮助我修改默认WSDL（我真的很喜欢那个页面）的东西会很棒。我所需要的只是在部署服务时自动提供文档。

有什么建议吗？

我应该如何为我的 Web 服务 API 生成文档

也许最简单的方法是使用 XML 文档注释。

XML 文档注释

使用这些注释，您可以自动生成 HTML 文档。例如，使用 Sandcastle 或 NDoc3：

在构建 Visual Studio 项目时构建 Sandcastle 文档

毕竟，您可以自动将html文档保存到服务附近的共享位置，并且可以使用浏览器轻松导航到那里。所以，一切都可能接近 - wsdl + html 文档

这相当容易。如果你用 tripple///注释装饰所有的类和方法，那么你可以从中生成文档。看这里：

http://msdn.microsoft.com/en-us/library/dd233217.aspx

http://www.developerfusion.com/article/84436/documentation-made-easy-with-c-and-xml/

同意其他海报，但是我使用 NDoc3 取得了很大的成功。它比Sandcastle快得多（Sandcastle也是一个非常好的工具）。NDoc3 将创建 .chm、.doc 和.html输出。

NDoc3 和 Sandcastle 都生成 MSDN 风格的文档。

NDoc3 - http://sourceforge.net/projects/ndoc3/

相关文章：