rdoc,darkfish和:call-seq:tag
-
30-09-2019 - |
题
我正在使用RDOC记录一个红宝石项目,并发现了Darkfish RDOC格式化器。我真的很喜欢,但是 :call-seq:
标签不再起作用。相反,它放置了字符串 :call-seq:
在文档中,然后将呼叫序列本身格式化为代码块。我不想只采用所有:呼叫序列:块中的块,因为我的大部分文档需要参考实例名称和参数名称 :call-seq:
堵塞。有没有其他人有这个问题?我该怎么办,还有解决方法吗?我很确定 :call-seq:
当我使用默认格式化器时,标签在工作之前正在工作,但是我无法确定,因为我无法弄清楚如何返回生成原始格式(即使文件除非文件,否则没有参数的rdoc,否我删除了DOC文件夹!)有人知道如何解决此问题吗?
解决方案
我强烈建议从RDOC搬到 院子. 。它不支持旧的呼叫键本身,而是具有标签,尤其是 @超载 标签将替换呼叫序列。所有文档 rubydoc.info 也是使用院子生成的。
这是从院子文档中@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
不隶属于 StackOverflow