Question

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

Answer 1

我强烈建议从rdoc转移到YARD。它不支持旧的call-seq本身，而是它有标签，特别是@overload标签将优先取代call-seq。 rubydoc.info上的所有文档也是使用YARD生成的。

以下是YARD文档中@overload的示例：

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end

rdoc，darkfish和：call-seq：标签

1 个答案: