Question

我看到如果安装了gem，也会生成rdoc，你可以通过

访问rdoc

gem server #->localhost:8808

我正在考虑如何描述ruby-developer如何使用已安装的gem的最常见方法。我来自（java）的apidocs / howtos例如已经包括在罐子里。

我看到有一种README.rdoc文件 - 会议（？）并且认为可能是红宝石开发人员在下载宝石后会开始寻找的？

Answer 1

这取决于开发者。

如果自述文件被大量标记（例如，大量的Markdown或RDoc），通常最方便的是使用gem server从本地gem doc服务器访问Gem文档。

或者按照gem服务器列表中的www链接，或手动读取文件。

其他文档源通常包含在doc目录中，使用普通的Ruby工具（rake和/或rdoc）构建。

我不是完全确定你在问什么。首先，Java库通常不包含API文档或源代码，它们通常是单独捆绑的，特别是如果您使用的是Maven。 Gems包含源代码，因此可以始终生成RDoc。

在Java中，只有在（a）开发人员（IMO滥用）Javadocs时才会出现示例，方法是在API文档中包含示例，或者（b）示例包含在源代码中并且您拥有源代码。在下载的Java库中很少有“howtos”，除非它是使用Maven开发的，您打包该站点，并且该站点包含超出常规API报告的使用页面。