问题标签 [rdoc]

我有现有的 Java 类，它们通过 JRuby 暴露给 Ruby 脚本，我希望能够向将使用 Java 对象的 Ruby 开发人员提供 RDoc 样式的文档。

是否可以从 Java 类生成 RDoc 文档？或者我是否需要维护/生成它们的存根版本作为可以对它们执行标准 RDoc 的 ruby​​ 类？

我正在尝试使用 3.5.3 版美化我的 rdoc 文档。我不喜欢内置的 darkfish 主题，所以我试图找到一种方法来用http://api.rubyonrails.org/上的官方 Rails API 文档使用的主题替换它，但我已经没有运气以任何现成的形式找到它。除其他外，我已经搜索了整个 github。

到目前为止我发现的是

• https://github.com/mislav/hanna

这可能有点过时了，它是叉子

• https://github.com/rdoc/hanna-nouveau

两者都很好，但不是我想要的。所以在我开始摆弄这些模板之前，有没有人知道 Rails API 文档使用的模板是否可以在某个地方作为 gem 使用？

谢谢！

我正在使用 Ruby on Rails 3.0.7，我想安装和使用新的 RDoc 模板（而不是默认模板）来记录我的应用程序。

我想选择以下之一：

• http://api.rubyonrails.org/
• http://www.ruby-doc.org/core/
• ...您建议的其他人

所以，

1. 我在哪里可以获得上述模板之一？
2. 我怎样才能安装它？
3. 我应该在.rake文件中放入什么代码来使用所选模板生成文档？

简而言之，我是这方面的新手。

此时，在我的 Gemfile 中，我声明了以下内容：

并运行bundle install命令。

更新我@dmarkow

我安装了horo.rake gem 并在我的文件中插入了以下代码

如果我运行命令rdoc -f horo --main README.rdoc *.rdoc lib ext，我会得到：

如果我运行命令rake doc:app，我会得到：

@dmarkow的更新二

我删除了doc目录：

如果我运行命令rdoc -f horo --main README.rdoc *.rdoc lib ext，我会得到：

在文档目录中，它创建一个created.rid文件。

如果我运行该命令rake doc:app，我会得到与以下 UPDATE 相同的结果。

我必须做什么？我还需要保留gem "rdoc", "~> 3.6.1"在我的 Gemfile 中吗？

我现在正在记录一些 ruby​​ 代码。我们有两个类，它们都有一个名为“host”的方法。

在这些类之一中，该方法需要一些特殊的注释。在另一堂课中，我想引用第一堂课，并将该引用作为指向它的链接。

通常在 rdoc 中，输入方法的名称就足以生成链接。在这种情况下，即使我写出Class::SubClass.host链接仍然坚持指向当前类中的方法。

那里的任何 rdoc 大师都知道如何做到这一点？

这是FakeTown::Api我要链接到RealTown::Api方法的示例#host：

rdoc 生成的链接无用地链接回#host本文档中的方法。

谢谢！

我有一些没有 ri/rdoc 文件的 gem，我想知道是否有办法安装这个 rdoc 文件。

我正在使用 Ruby on Rails 3.0.7，并试图了解RDoc系统是如何工作的。所以我想了解当官方文档在第 7 行提到“哈希”值是什么意思：

1. 类的名称、源文件以及任何包含下划线或前面带有井号 字符的方法名称都会自动从注释文本超链接到它们的描述。

你能给我举个例子，在我的注释代码中说明这一点吗？你对使用它有什么建议吗？

顺便说一句：您是否有参考 RDoc 的“必须阅读”资源？如果是这样，你能提供吗？

我正在使用 Ruby on Rails 3.0.7，我想记录我的应用程序。为此，我会找到一些关于RDoc的“好”文档。

我在哪里可以找到那个？也就是说，在哪里可以找到有关RDoc的文档的“最佳”网络资源是什么？

我正在使用 Ruby on Rails 3.0.7 并且正在使用RDoc为我的应用程序编写一些文档。由于我在网上没有找到一些带有示例的好的文档，所以我想知道的是如何使用该:include:指令。

你能给我一个在应用程序文件中使用它的例子吗？

我正在使用 Ruby on Rails 3.0.7，并且正在使用 RDoc 为我的应用程序编写一些文档。在我的应用程序文件中，我有这个：

在为我的应用程序生成文档时，上面注释的代码将离开段落块之外的部分应该出现的地方class User < ActiveRecord::Base。end

以下是相关的屏幕截图：

我该如何解决？

如果我使用它，我会得到相同的输出（在应该出现类语句的段落块之外）

或这个

我正在使用 RDoc 为我的 Ruby on Rails 3.0.7 应用程序编写文档。在应用程序lib文件夹中，我有以下内容：

当我尝试为上面的代码生成文档时，RDoc 不会解析#'CONSTANT' documentation text和#'method_name' documentation text，所以输出文档是空白的。

1.如何让RDoc考虑模块“上下文”中的注释代码？

如果我:doc:按如下方式使用指令，这将无济于事：

我注意到我在Class\Module Index中有这些：

2. 它们是什么意思？