1

我正在寻找支持以下功能的文档框架：

  • 从代码注释生成
  • 可搜索
  • 造型可定制
  • NTH：链接引用（如果我在某处引用某个类，则类名应链接到类文档）

我想用它来记录我正在处理的 RESTfull API

我知道 YARDoc，但很高兴收集一些替代品

4

2 回答 2

1

Matt Silverman 创建了一个非常全面的列表，列出了现在可以从代码中生成文档的内容。

http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html

于 2013-04-09T21:06:13.417 回答
0

除了 YARD，您还可以使用以下 rake 任务生成 RDOC 项目文档：

rake doc:app

之后，您的文档将位于doc/app文件夹中，可以通过index.html在浏览器中打开文件来查看。它将包括（目前可能是通用的）doc/README_FOR_APP文件。

希望这可以帮助 ：）

于 2013-04-09T15:17:08.867 回答