我试图使用yard记录一些Ruby代码，尽管我所做的正是所描述的here或here#@param[Integer]thenumberoftrials(>=0)#@param[Float]successprobabilityineachtrialdefinitialize(n,p)#initialize...end虽然我仍然得到这个奇怪的错误@paramtaghasunknownparametername:the@paramtaghasunknownparametername:success然后生成的html看起来很奇怪。我称yard为:$yarddoc-mmarkdown我做错了什么？
我得到了我认为是相当基本的院子宏用法，其中我有一个散列结构，其中包含多个选项，这些选项在多个函数之间共享。我希望使用一个宏来防止我不得不在所有地方复制这个结构，但它似乎并没有那样工作。我期望的工作是:#@macro[new]my_hash#@param$1[Hash,Array]Inputtedmy_hash#@option$1[String]:aValueforA.#@option$1[String]:bValueforB.#@option$1[String]:cValueforC.###my_funcdoesstuff#@macromy_hashh1defmy_funch1end#
我一直在尝试从源代码添加一个vagrant插件(https://github.com/schisamo/vagrant-omnibus)。我下载了它，进行了“捆绑安装”，一切顺利。但是当我执行“rakeinstall”时，它显示了以下错误:rakeaborted!cannotloadsuchfile--yard这是带有跟踪的完整错误日志:rakeaborted!cannotloadsuchfile--yard/root/chef-solo-example/vagrant-omnibus-master/Rakefile:5:in`require'/root/chef-solo-examp
我有一些如下所示的Ruby代码:#some_string="{really?}"大括号需要是字符串的一部分。这一行是注释掉的代码，我想保留在那里。我还使用YARD来记录代码，所以当我运行yarddoc时，它(自然地)会发出无法“真正”链接的警告。有没有办法让YARD忽略注释掉的代码？ 最佳答案 IsthereawayIcantellYARDtoignorecommentedoutcode?一方面，YARD记录支持Rdoc标记。并且Rdoc被记录为支持几种隐藏部件的方法。RDocstopsprocessingcommentsifitf
YARD允许我指定方法参数和返回值的类型。因为我真的很喜欢躲避类型，所以很高兴看到YARD还支持通过指定它们必须支持的方法来定义类型。如你所见here,像#first_method,#second_method这样的表达被解释为逻辑析取。这意味着对象需要支持#first_method或#second_method或两者。这不是我需要的。我希望能够指定一个对象需要同时支持我的参数的#first_method和#second_method。有办法指定吗？ 最佳答案 没有用于指定复合鸭子类型接口(interface)的惯用语法。也就是说，
我有一个函数，它接受可变数量的参数，如下所示:defmyfun(*args)#...end所有参数都是同一类型(Symbol)，所以现在我记录函数就像只有一个参数一样，说它可以接受多个参数，例如:#thisfunctiondoesn’tdoanything#@param[Symbol]:thisargumentdoessomething,youcanaddmoresymbols#ifyouwantdefmyfun(*args)#...end是否有内置方法来处理这种情况？ 最佳答案 以下是有道理的，因为args是方法内部的一个Arra
我有这样的方法defself.import(file_name,opts={})我正在尝试用YARD记录下来。然而，这是一种100%副作用的方法(我知道，我知道，副作用，呃!)。但是对于此方法的用户，实际上没有任何类型的返回对象，但是YARD生成如下签名:+(Object)import(file_name,opts={})有什么办法可以告诉yardimport方法什么都不返回吗？我可以告诉它返回nil，但这不是一回事 最佳答案 所有方法都会返回一些东西，void关键字可能就是您要查找的内容。#@return[void]defmeth
我正在将我维护的rubygem从RDoc切换到YARD文档。但是，代码中有一些关键注释只需要保留在代码中，不应出现在文档中。例如:###SomeClassdocumentationhere.#--#CRITICALcommentthatshouldbeinthecodebutnotinthedocumentation,#andmustbeatthisparticularspotinthecode.#++#moredocumentationthatfollowsthecriticalcommentblock,butthispart#shouldbeinthegenerateddocu
我下载了rubyTwittergem源代码并尝试使用yard生成文档，我通过geminstallyard安装了它。在rakefile中，我发现了以下内容，我认为它用于为Twittergem生成文档:require'yard'YARD::Rake::YardocTask.new我尝试在irb中requireyard然后运行YARD::Rake::YardocTask.new但没有任何反应。你能帮我走上正轨吗？ 最佳答案 来自theYARDdocs:Thesecondmostobviousistogeneratedocsviaa
我想在yard-genereted文档中包含图像，但无法在任何地方找到如何执行此操作...有人知道如何执行此操作吗？ 最佳答案 您可以只添加标记到您的文档:#Blah-blah###@param[String]blah#@return[String]blahdeffoo(bar)end 关于ruby-yard，如何将图像包含到文档中？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions
