blocks|key|1594018|text|Matt创建了一个非常全面的列表，列出了现在用于从代码中生成文档的可用内容。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1594019|http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html|offset|length|1594020|entityMap|0|LINK|mutability|MUTABLE|url^0|0|0|2F|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|N|8|@]|9|@$D|O|E|P|1|Q]]|A|$]]|$1|F|3|-4|5|6|7|R|8|@]|9|@]|A|$]]]|G|$H|$5|I|J|K|A|$L|C]]]]

Matt Silverman created a pretty comprehensive lists of what is available out there now for gen'ing docs from code.

<a href="http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html" rel="nofollow">http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html</a>

blocks|key|2271964|text|除了院子之外，您还可以使用以下rake任务生成RDOC项目文档：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|2271965|rake+doc:app|code-block|syntax|javascript|2271966|之后，您的文档将位于doc/app文件夹中，可以通过在浏览器中打开index.html文件来查看。它将包括(目前可能是通用的)+doc/README_FOR_APP文件。|offset|length|style|CODE|2271967|希望这会有所帮助:)|2271968|entityMap^0|0|0|A|7|X|A|1S|I|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|R|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|S|8|@$I|T|J|U|K|L]|$I|V|J|W|K|L]|$I|X|J|Y|K|L]]|9|@]|A|$]]|$1|M|3|N|5|6|7|Z|8|@]|9|@]|A|$]]|$1|O|3|-4|5|6|7|10|8|@]|9|@]|A|$]]]|P|$]]

Apart from YARD, you can generate RDOC project documentation using the following rake task:

<pre><code>rake doc:app
</code></pre>

After this, your docs will be located in the <code>doc/app</code> folder and can be viewed by opening the <code>index.html</code> file in your browser. It will include the (currently probably generic) <code>doc/README_FOR_APP</code> file.

Hope this helps :)

im searching for a Documentation Framework that supports the following features:

<ul>
<li>Generated from Code Comments</li>
<li>Searchable</li>
<li>Styling customizable</li>
<li>NTH: Linked references (If i reference a class somewhere class name should be linked to class documentation)</li>
</ul>

I want to use it to document an RESTfull API i'm working on 

I know about YARDoc, but would be nice to gather some alternatives

Rails RESTfull API Documentation

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

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

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

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

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

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

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

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

EdgeOne AI 安全实战专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云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编辑器全新改版上线，欢迎大家体验!

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

社区新版编辑器体验调研

我正在寻找一个支持以下特性的文档框架：从代码注释生成可搜索造型可定制NTH:链接引用(如果我引用某个类，类名应该链接到类文档)我想用它来记录我正在做的RESTfull API我知道YARDoc的事，但是我很乐意收集一些替代方案。

问Rails RESTfull API文档
EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Rails RESTfull API文档EN

回答 2

Stack Overflow用户

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问Rails RESTfull API文档
EN