blocks|key|1181410|text|一个不错的解决方案是使用xml文档注释自己构建文档，然后从生成的xml创建web页面。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1181411|DIY|offset|length|style|BOLD|1181412|关于使用xml注释的MSDN+article。|1181413|工具/插件|1181414|有一些库可以让您轻松地为api创建文档。|1181415|Atomineer非常好，可以创建许多不同格式的文档来满足您的需求。|1181416|网络应用编程接口|1181417|通过一个漂亮的UI将Web+API+documentation放入到您的项目中来公开它。这也使用了xml文档，您可以将自己的详细信息添加到开箱即用的文档中。|1181418|断掉的链接，我正在尝试重新找到它。这里有一篇关于这个方法api+documentaion的很好的博客|1181419|entityMap|0|LINK|mutability|MUTABLE|url|http://msdn.microsoft.com/en-US/library/z04awywx(v=vs.120).aspx|1|http://www.atomineerutils.com/|2|http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages|3|http://www.robertbeal.com/26/creating-api-documentation^0|0|0|3|0|A|C|0|0|0|5|0|0|0|9|1|0|0|8|0|A|L|2|0|S|G|3|0^^$0|@$1|2|3|4|5|6|7|19|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|1A|8|@$D|1B|E|1C|F|G]]|9|@]|A|$]]|$1|H|3|I|5|6|7|1D|8|@]|9|@$D|1E|E|1F|1|1G]]|A|$]]|$1|J|3|K|5|6|7|1H|8|@$D|1I|E|1J|F|G]]|9|@]|A|$]]|$1|L|3|M|5|6|7|1K|8|@]|9|@]|A|$]]|$1|N|3|O|5|6|7|1L|8|@]|9|@$D|1M|E|1N|1|1O]]|A|$]]|$1|P|3|Q|5|6|7|1P|8|@$D|1Q|E|1R|F|G]]|9|@]|A|$]]|$1|R|3|S|5|6|7|1S|8|@]|9|@$D|1T|E|1U|1|1V]]|A|$]]|$1|T|3|U|5|6|7|1W|8|@]|9|@$D|1X|E|1Y|1|1Z]]|A|$]]|$1|V|3|-4|5|6|7|20|8|@]|9|@]|A|$]]]|W|$X|$5|Y|Z|10|A|$11|12]]|13|$5|Y|Z|10|A|$11|14]]|15|$5|Y|Z|10|A|$11|16]]|17|$5|Y|Z|10|A|$11|18]]]]

A nice solution is to build the documentation yourself using xml documentation comments and then creating web pages from the resulting xml.

DIY

<a href="http://msdn.microsoft.com/en-US/library/z04awywx(v=vs.120).aspx" rel="nofollow noreferrer">MSDN article</a> on using xml comments.

Tools/Plugins

There are a few libraries out there that make it simple for you to create documentation for your api.

<a href="http://www.atomineerutils.com/" rel="nofollow noreferrer">Atomineer</a> is very good and can create documentation in many different formats to meet your needs.

Web API

With <a href="http://www.asp.net/web-api/overview/creating-web-apis/creating-api-help-pages" rel="nofollow noreferrer">Web API documentation</a> is rolled into your project with a nice UI to expose it. This also uses xml documentation and you can add your own details to that which comes out of the box.

[Broken link, am trying to find it again.]
Heres a good blog post on this method <a href="http://www.robertbeal.com/26/creating-api-documentation" rel="nofollow noreferrer">api documentaion</a>

blocks|key|4740164|text|我使用一个名为TechWriter+for+Web+Services的文档生成器。它不是那么贵，而且为我节省了很多时间。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|4740165|entityMap|0|LINK|mutability|MUTABLE|url|http://www.adivo.com/techwriter-for-web-services.aspx^0|7|R|0|0^^$0|@$1|2|3|4|5|6|7|L|8|@]|9|@$A|M|B|N|1|O]]|C|$]]|$1|D|3|-4|5|6|7|P|8|@]|9|@]|C|$]]]|E|$F|$5|G|H|I|C|$J|K]]]]

I use a documentation generator called <a href="http://www.adivo.com/techwriter-for-web-services.aspx" rel="nofollow">TechWriter for Web Services</a>. It's not that expensive and has saved me a lot of time.

blocks|key|1181395|text|IMHO+Sandcastle+works+pretty+nicely|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|1181396|使用现有xml文档生成类似于msdn文档的.chm或.html文件的免费工具。|1181397|entityMap|0|LINK|mutability|MUTABLE|url|http://shfb.codeplex.com/^0|0|Z|0|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@$A|O|B|P|1|Q]]|C|$]]|$1|D|3|E|5|6|7|R|8|@]|9|@]|C|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]]]

<a href="http://shfb.codeplex.com/" rel="nofollow">IMHO Sandcastle works pretty nicely</a> 
Free tool that uses existing xml documentation to produce .chm or .html files that look similar to msdn documentation.

Online webservice API/reference guide - What software application do you use to document your webservice/API technical specification/reference guide?

Documenting webservice API Reference guide?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云AI代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

功能1上新10个字符

功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符功能2描述100个字符。

功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符功能2上新100个字符。

功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符功能5描述100个字符

功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符功能5上新100个字符

功能4上新

文章&问答评论现已支持表情

全新交互，全新视觉，新增快捷键、悬浮工具栏、高亮块等功能并同时优化现有功能，全面提升创作效率和体验

社区富文本编辑器全新改版！诚邀体验～ 

精选全网热门MCP server，让你的AI更好用 🚀

💥开发者 MCP广场重磅上线！

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

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

问记录webservice API参考指南？
EN

回答 3

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录webservice API参考指南？EN

回答 3

Stack Overflow用户

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问记录webservice API参考指南？
EN