记录webservice API参考指南？

Question

在线网络服务API /参考指南 - 您使用什么软件应用程序来记录您的网络服务/ API技术规范/参考指南？

Answer 1

一个不错的解决方案是使用xml文档注释自己构建文档，然后从生成的xml创建网页。

<强> DIY

MSDN article使用xml评论。

工具/插件

有一些库使您可以轻松地为api创建文档。

Atomineer非常好，可以创建多种不同格式的文档，以满足您的需求。

Web API

将Web API documentation添加到您的项目中，并使用一个很好的UI来公开它。这也使用xml文档，您可以将自己的详细信息添加到开箱即用的文档中。

[破碎的链接，我试图再次找到它。] 这是关于这种方法api documentaion

的好文章

Answer 2

我使用名为TechWriter for Web Services的文档生成器。它并不昂贵，为我节省了很多时间。

Answer 3

IMHO Sandcastle works pretty nicely
免费工具，使用现有的xml文档生成类似于msdn文档的.chm或.html文件。