假设我有以下 function：@param foo [Array<String>] def recursive_split(foo) bar = [] foo.each do |elem| bar.append(elem.split('')) end bar ...
我知道我应该使用 YARD。 在这种环境中不是一个选项。 所以我使用 rdoc 并且 call-seq 通常很棒，但是我想为始终以块/yield 样式使用的 call-seq 添加缩进，例如： 但是 call-seq: 删除任何缩进，它变成： 这是可悲的。 我知道我可以使用单独的代码块作为 ...
以下是接受字符串数组或空白数组 ( [] ) 的方法片段：# @param [Array<String>] bar def foo(bar) if bar.empty? # Do this else # Do that end end 我觉得这种@para ...
我的 class 将一个方法委托给另一个 object（我将其称为辅助对象）。 我想在委托 class 中包含该方法的文档，而不仅仅是委托 class。 程序员不应使用帮助程序 object，而应仅使用主 object，因此在帮助程序 object 中记录不是很有用。 考虑这个例子。 Rdoc ...
我在 Windows 系统上安装了 JRuby 9.2.11.1。 安装成功完成后，不存在 core/stdlib 的 ri 文档。 例如： 我试过这个解决方案如何安装 Ruby ri 文档？ （诚然，对于 Ruby 安装程序，而不是 JRuby）无济于事。 尝试运行rdoc --all --r ...
我正在尝试使用 RDoc 将文档写入我的一个类，但我遇到了以下问题： 这是我的来源：module Native module Facebook # Service, which starts(schedules) Native Facebook Fetching Jobs for us ...
我想在rubydoc中为参数或变量或@return声明具有确切对象类的对象数组。 （必须是RDoc ？。） 使RubyMine（或其他IDE）以正确的方式工作于自动完成功能，可点击方法，重构等的主要原因是。 在PHP中将如下所示： 我只是不确定它是否可以在RubyMine中 ...
在PHP中，我们可以描述任何变量，并在类似PHPStorm的IDE中获得正确的自动完成功能。 有什么方法可以使用RDoc在RubyMine中实现？ ...
我想要一段代码，如哈希，在生成的 html 上以固定字体显示。 假设这是我的文件的内容： 如何指示 yard（使用版本0.9.15的默认值）以便yard doc file.rb将生成，对于哈希示例，相当于在 markdown 格式中添加 4 个反斜杠，或 4 个起始空格到 stackoverfl ...
我正在做一个非常大的Rails项目，我想在代码库中标准化rdoc的用法。 我认为我可以在整个项目中运行一次（至少为类和方法本身生成文档），然后开发人员可以在添加文档时添加单个文件。 问题是，如果我运行rdoc /path/to/some_file.rb ，它将从生成的index.html ...
搜索RDoc文档后，我找不到如何在RDoc中记录文件/顶级方法... 假设我有以下代码： 使用此代码运行RDoc只会生成Foo类的文档，在这里我想拥有foo.rb文件和顶级方法foo_method（）的文档。 所以我的问题是： 如何使RDoc文档文件和顶级方法？ ...
我继承了带有rdoc注释的一堆Ruby代码，但是许多选项和属性都是多行的，例如： 使用rdoc，sdoc或yard很难阅读最终文档。 每个显示第二行的方式都不同。 我想念什么吗？ 有什么方法可以保留换行符，但可以使生成的文档正确吗？ ...
在Padrino项目中，Ruby本身很聪明，知道我要引用我的Page模型而不是分页器的Page类。 但是RubyMine迷路了，认为我正在处理分页并坚持标记一些错误（随着new论点的变化）。 在这些情况下我该怎么办？ 在PHPStorm上，我习惯在变量上方添加一个PHPDoc来告诉 ...
我注意到，当我生成一个新的Rails应用程序时，有时我会遇到一个readme.md，有时甚至是一个readme.rdoc（Bitbucket显然不会自动呈现）。 如果您对此有任何想法，请告诉我。 ...
运行我的脚本时出现此错误： 从 我在我的Gemfile中有rdoc 我也试过没有指定版本。 在我的脚本中，我需要宝石和rdoc /用法： 我已经运行了gem install rdoc 因为我正在运行ruby 2.2.2应该不需要安装ruby roc / ...
例如， 安装任何新gem时，会引发NoMethodError异常。 我搜索了它并搜索了RDoc和RubyGems GitHub存储库中的问题，但没有运气。 我的Ruby版本是 RubyGems版本是 安装的RDoc版本是 我在Mac OS X El Cap ...
我只是想为我的gem生成文档，并且在运行rdoc或yard时出现错误 到底是怎么回事？ 我正在尝试重新安装所有内容，并且使用的是ruby 2.3.1。 另外，据我了解，您不能在数组上使用intern，那么为什么rdoc和yard会尝试这样做？ 编辑 我现在已经进行了进一步 ...
在尝试创建我的 rails 控制器和使用的参数的文档时，我被卡住了，因为 yard 似乎期望参数作为方法参数存在。 所以对于这个文档 yard 会发出警告并且不会创建文档： 有没有办法使用 yard 来记录这些类型的物品，还是我需要手动完成？ ...
官方文档表明我应该能够使用rake doc:app为我的应用程序构建文档，但是当我在Rails 5中运行命令时，我得到以下输出： ...
我有开放式的Rails控制台，想使用复数方式，但是我收到错误，因为NoMethodError: undefined method main：Object`的NoMethodError: undefined method 复数（1，'人'） 我可以在这里http://www.rubyd ...