ruby - 如何在YARD文档中创建任意链接？

我正在尝试在我的YARD文档中创建一些链接。我可以得到一个HTTP链接:

# I like {http://stackoverflow.com Stackoverflow}

呈现为

<p>I like <a href="http://stackoverflow.com">Stackoverflow</a></p>

但是一个电子邮件链接:

# You can email the {mailto:[email protected] bugs} list

给我一个警告:

[warn]: In file `':: Cannot resolve link to mailto:bugs@myprojectmailto:[email protected] from text:

并呈现为

<p>You can email the <tt>bugs</tt> list</p>

我已经尝试了链接的常规RDoc语法:

bugs[mailto:[email protected]]

但是YARD似乎忽略了这一点。有人知道更可靠的语法吗？

最佳答案

深入了解YARD的代码可发现问题所在:gems/yard-0.2.3.5/lib/yard有一行(73):

if name.include?("://")

不允许使用mailto链接。您可以将这一行替换为

if name.include?("://") or name.include?("mailto:")

它会按您的意愿工作...并非完全理想，但这就是我现在所拥有的。

关于ruby - 如何在YARD文档中创建任意链接？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/1294024/