Tag: 文档

rdoc，darkfish和：call-seq：标签

我正在使用rdoc记录Ruby项目，我发现了darkfish rdoc格式化程序。 我非常喜欢它，但是:call-seq:标签不再有效。 相反，它将文字字符串:call-seq:放在文档中，然后将调用序列本身格式化为代码块。 我不想从我的代码中取出所有：call-seq：blocks，因为我的大部分文档都需要引用:call-seq: block中给出的实例名称和参数名称。 有没有其他人有这个问题？ 我该怎么办，是否有解决方法？ 我很确定:call-seq:标签在我使用默认格式化程序之前正在运行，但我无法确定，因为我无法弄清楚如何返回生成原始格式（调用rdoc与除了文件之外没有任何参数现在生成暗鱼输出，即使我删除了doc文件夹！）有谁知道如何解决这个问题？

Yard文档工具中的@tag和@！标签有什么区别？

在查看Yard文档和示例时，我发现一些标签以感叹号为前缀。 我发现有和没有感叹号的工作示例，我无法发现差异，所以当使用@!some-tag代替@some-tag时会发生什么变化？ 例如，此代码为attr和attr2生成相同的文档 class Anything # @!attribute [rw] attr # @attribute [rw] attr2 end 另一方面，在一些 例子中，感叹号的重要性有下划线，所以它应该做一些事情，但我找不到任何关于它的使用的文档。 @！方法示例 Rails模型中的这两个注释都会生成新方法 # @!method with_bang(param) scope :foo_bar, where(foo: ‘bar’) # @method without_bang(param) scope :foo_baz, where(foo: ‘baz’) 码输出：

动态文档，使用另一个YARD描述中的方法返回？

我正在记录一个项目，并且我有类似于以下内容： def foo return bar(__method__) end def bar (method) return method.to_s + ‘somestring’ end 我正在设置多种类似于我实现foo的方法，他们正在返回bar的返回值。 一个例子如下： # The descriptions for foo0… # @return [String] the method name concatenated with somestring def foo0 return bar(__method__) end # The descriptions for foo1… # @return [String] the method name concatenated with somestring def foo1 return bar(__method__) end # […]

为本地安装的gem生成RDOC

我正在努力为我最近感兴趣的一颗gem做出贡献 – 内斯塔。 开发人员在创建您可以找到的最轻，最最好的CMS之一方面做得很好，我想记录它。 我已经阅读了代码，并根据我的知识对一些方法进行了评论。 但是，我试图通过调用gem server在本地测试它，并在推送它之前查看我的机器上的更改。 我尝试过的事情： 手动编辑。 记录文件。 解雇了gem server 。 使用gem工具。 记录文件。 Ran gem rdoc nesta –rdoc 重启gem server 一切都无济于事。 请帮忙。 谢谢。

Ruby openssl文档

有没有Ruby的openssl库的在线文档？ 我所能找到的只是博客文章和第三方文章，rdoc本身并没有真正解释如何逐步使用库。

Yard doc和`define_method`

有没有办法在YardDoc中注释使用define_method的方法 ？ 我试过这个： %w(one two three).each do |type| # The #{type} way # @return [String] the #{type} way define_method(“#{type}_way”) do … end end 但是，不幸的是，没有工作。

在rdoc中显示inheritance的方法

我有一个用Ruby编写的程序，它使用多级inheritance。 所有父类都实现了子类的对象将使用的方法，但是当我为我的程序生成rdoc时，子类的rdoc页面仅显示该特定类的方法，而不显示父类的方法。 有谁知道如何在rdoc中显示inheritance的类方法？ 我查看了rdoc文档和一些网站，但未能找到答案是否可行。

如何使Yard` @ macro`s适用于多个文件

如果我在一个文件中有以下内容： module Something class Resource # Defines a new property # @param [String] name the property name # @param [Class] type the property’s type # @macro [attach] property # @return [$2] the $1 property def self.property(name, type) end end class Post < Resource property :title, String property :view_count, Integer end end 使用get文档定义的methods property 。 但是，如果我在单独的文件中有这些定义，则文档生成不正确，例如在下面的情况中： […]

干燥场参数

我已经得到了我认为是一个相当基本的码宏用法，其中我有一个Hash结构，其中包含多个函数之间共享的多个选项。 我希望使用一个宏只是为了防止我不得不在整个地方复制这个结构，但它似乎并没有像那样工作。 我期望工作的是： # @macro [new] my_hash # @param $1 [Hash,Array] Inputted my_hash # @option $1 [String] :a Value for A. # @option $1 [String] :b Value for B. # @option $1 [String] :c Value for C. ## # my_func does stuff # @macro my_hash h1 def my_func h1 end ## # other_func does stuff […]

Rails指南脱机文档

是否有可下载的Rails指南离线版本？