我看到如果安装了 gem，也会生成 rdoc，您可以通过以下方式访问 rdoc
gem server #->localhost:8808
我正在考虑如何描述 ruby 开发人员如何使用已安装的 gem 的最常见方法。我来自（java）的apidocs / howtos例如已经包含在罐子中。
我看到有一种 README.rdoc 文件 -convention(?) 并想也许这就是 ruby-developer 在下载 gem 后开始寻找的地方？
问问题
58 次
1 回答
1
这取决于开发商。
如果 README 被大量标记（例如，大量的 Markdown 或 RDoc），通常最方便使用gem server从本地 gem 文档服务器访问 Gem 文档。
或者按照 gem 服务器列表中的 www 链接，或者手动读取文件。
其他文档源通常包含在doc目录中，使用普通 Ruby 工具（rake 和/或 rdoc）构建。
不过，我不完全确定你在问什么。首先，Java 库通常不包含 API 文档或源代码，它们通常是单独捆绑的，尤其是在您使用 Maven 时。Gems 包含源代码，因此始终可以生成 RDoc。
在 Java 中，仅当 (a) 开发人员（IMO 滥用）Javadocs 通过在 API 文档中包含示例，或 (b) 示例包含在源代码中并且您拥有源代码时，才会出现示例。下载的 Java 库中很少有“howtos”，除非它是使用 Maven 开发的，您将站点打包，并且该站点包含超出正常 API 报告的使用页面。
于 2012-09-10T12:28:35.760 回答