在YARD中，当参数类型或返回类型为同一项目中的类时，会自动创建指向该类页面的链接。Integer说，现在我想对Ruby核心类(或任何外部类)做同样的事情。我希望YARD将任何Integer类型链接到http://ruby-doc.org/core-2.2.3/Integer.html.一般我要YARD尝试链接"http://ruby-doc.org/core-2.2.3/#{cls.name}.html"如果cls不是我的项目本地的。YARD可以吗？对于熟悉Java的人，我正在尝试做类似the-linkoptionofJavadoc的事情. 最佳答案
除了指定它输出的内容外，我没有什么有用的东西可以写这个函数。如果Yard没有找到描述，它会使用@return的内容。有什么办法可以防止这种情况发生吗？我想避免像您在下面的示例中看到的那样愚蠢的重复。###@return[Array]##anarrayofhashes.Exampleoutput:##[#{:name=>"FORNEBU",:municipality=>"BÆRUM",:county=>"AKERSHUS"},#{:name=>"FORSAND",:municipality=>"FORSAND",:county=>"ROGALAND"}#]#
我正在开发一个Ruby编程教程，我想用Yard记录它。.默认情况下，Yard将模块/类中的所有方法按字母顺序排列。但是，由于教程中每个模块中的方法都是相互构建的，因此我希望按照我编写它们的顺序进行排序。有没有办法将Yard配置为不按字母顺序放置方法？ 最佳答案 默认模板不提供不对方法名称进行排序的选项。您的选择是创建自定义模板或修补默认模板。如果它有助于对方法进行排序的行是:https://github.com/lsegal/yard/blob/master/templates/default/module/setup.rb#L39
我目前正在开发一个gem并为其编写文档。我目前有一个类，它有几个使用defined_method定义的方法，如下所示:classClient['one','two'].eachdo|method_name|#Setsthevalue#@paramargumenttheargumenttoset.define_method("set_#{method_name}")do|argument|#Methodcontentendendend我尝试使用YARD记录这些方法，但是在生成项目文档时，这些方法没有出现在类文档中。有人知道我如何记录这些吗？我错过了什么吗？ 最
RDoc有:include:标签(参见thispage的底部)，它将接受任意文本文件和格式，就好像它在包含开始的地方缩进一样。这是为文档示例提取源代码的好方法。是否Yard有类似的标签或功能吗？ 最佳答案 目前YARD仅支持以以下形式嵌入来自其他对象文档字符串的文档:classFoo#Docstringheredefmethod;end#Hereissomemoredocsand{include:Foo#method}defbar;endend文件包含的计划含糊不清，但以前从未真正要求过，因此它的优先级不高。如果您想在http://
我同时使用Python和Ruby，我真的很喜欢Ruby'sYard文档服务器:http://yardoc.org/,我想知道Python世界中是否有类似的东西？“pydoc-p”真的又旧又丑，用起来一点也不舒服，而且看起来Sphinx和Epydoc也不支持服务器模式。你知道任何等价物吗？谢谢 最佳答案 Python包实际上并没有约定在哪里放置文档。包的主要文档可以使用一系列不同的工具构建，有时基于文档字符串，有时不是。您使用pydoc-p看到的只是包内容和文档字符串，而不是主要文档。如果这就是你想要的，你也可以使用Sphinx来达到
我正在尝试在我的YARD文档中创建一些链接。我可以获得一个HTTP链接:#Ilike{http://stackoverflow.comStackoverflow}呈现为IlikeStackoverflow但是一个电子邮件链接:#Youcanemailthe{mailto:bugs@myproject.combugs}list给我一个警告:[warn]:Infile`'::Cannotresolvelinktomailto:bugs@myprojectmailto:bugs@myproject.comfromtext:并呈现为Youcanemailthebugslist我试过链接的常
我已经决定将我的一个项目中的README文件转换为markdown，并且一直在使用yard验证呈现出来的文档是否正常。所以我安装了rdiscount，将README更改为README.md并尝试:yarddocREADME.md这给了我警告:[warn]:Syntaxerrorin`readme.md`:(3,18):syntaxerror,unexpectedtinteger,expecting$end所以我尝试了:yarddoc-mmarkdown--README.md同样的问题。运行:yarddoc--backtrace--README.md提供更多信息:[warn]:Synta
如果我有一个返回这个的函数:render:json=>@orders.as_json(include:[{:user=>{only::id}}],:only=>[:id,:status_id])我是这样记录的:#@return[JSON]includestheid,theorderstatusidandtheidoftheassociateduser我想知道是否有更好的方法来记录返回的JSON的外观。 最佳答案 因此，如果您关心API的文档，我假设您也关心测试，因此您的API端点可能有测试。我建议你使用RspecAPIDocumen
我想使用YARDoc记录以下方法.#Hereismymethod#@argwoop[Woop]*dangerous*thisparameterisoutputtothescreendefshoop(woop)putswoopend这会生成HTML，其中dangerous是粗体。因为我必须解析这个输出，所以我想要一个自定义的HTML标签。换句话说，我想这样做，以便当以下代码注释被YARDoc解析时,这个词dangerous被包围标签，而不是标签，让Nokogiri更容易解析。并不是说目前无法使用Nokogiri进行解析，它只是有点笨拙并且容易受到YARD代码更改的影响。#Hereismy
