我有一个这样记录的函数:###Searchesforstreetnamesinthelocaladdressdatabase.Returnsalist#ofstrings,orinvokestheblockforeachresult.##@param[String,Hash]query##Canbe:##-Asearchstringwithoptinalwildcards.Examples:#-"Bærumsv*"#-"Fornebuve_en"##@param[Integer]limit##Limitstheamountofresults.See{#search_street_add
我有一个从工厂函数创建的类，如下所示:Cake=MyProject.Struct(:type,:price)在Yard中，它只是与我的常量一起显示:Cake=Struct(:type,:price)Iwantittoshowupinthe"Classes:"list.Afterreadinguponthedocs,Iwasleadtobelievethatthiswouldwork:#@!parseclassCake;endCake=MyProject.Struct(:type,:price)但它确实没有任何改变。是否可以让Yard将动态创建的类记录为类？
我有一个典型的OO模式:一个基本抽象类(定义抽象方法)和几个以特定于类的方式实现这些抽象方法的类。我习惯于在抽象方法中只编写一次文档，然后它会自动传播到几个具体类(至少它在Javadoc、Scaladoc、Doxygen中按以下方式工作)，即我不需要重复所有具体类中的相同描述。但是，我找不到如何在YARD中进行此类传播。我试过，例如:#Somedescriptionofabstractclass.#@abstractclassAbstractClass#Somemethoddescription.#@return[Symbol]somereturndescription#@abstra
如果我想查看有关我的gem的文档，我可以这样做:yardserver--gems如何查看Ruby标准库的文档？ 最佳答案 你必须下载Ruby代码存档并将其解压到一个目录中，运行yardoc*.c(将生成核心文档)，2a.运行yardoc.(这将生成stdlib文档，但会花费大量时间)，运行yardserver。(来自http://gnuu.org/2010/10/13/local-copies-of-documentation/) 关于ruby-所有Ruby文档离线带码，我们在Sta
我有一个使用Forwardable中的def_delegators方法的类模块。我还没有找到获取Yardoc的方法为其输出文档。我试过使用macro但它不会为这些特定方法输出任何内容(文件中的其他一切都很好，并且没有错误)，而且我有几个不同长度的def_delegators。例如classAextendForwardable#othercode…#@!macro#@seeArray#$1#@seeArray#$2#@seeArray#$3def_delegators:@xs,:size,:是否有gem或方法可以避免尝试编写Yard扩展？ 最佳答案
关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭4年前。Improvethisquestion我有一个方法应该接受任何类的1+个参数，类似于Array#push:defmy_push(*objects)raiseArgumentError,'Needs1+arguments'ifobjects.empty?objects.eachdo|obj|puts"Anobjectwaspushed:#{obj.inspect}"@my_array.pushobjendend使用YARD语法记
如何使用YARD创建指向ruby类方法的链接？这是yarddocumentation关于链接。链接到同一命名空间内的实例方法:{#my_instance_method}效果很好。但是，使用类方法遵循相同的方法并不能编译，修改它:{#self.my_class_method}生成以下纯文本(不是链接):ObjectName#self#self.my_class_method 最佳答案 只用名字，裸:{class_method}或者如果它在不同的命名空间中{Object.class_method}
我正在使用YARD为我的rubygem编写文档.在我的gem中，我有一些代码遵循这种常见的ruby模式，其中一个模块包含在一个类中，并且该模块不仅添加了实例方法，还添加了类方法:moduleMoodefself.included(klass)klass.extendClassMethodsendmoduleClassMethodsdefhelloputs"hello"endendendclassFooincludeMooendFoo.hello#=>classmethodruns,printing"hello"默认情况下，YARD将为Foo类生成如下所示的文档:我认为此文档不充
我正在使用YARD使用makrdown作为脚本解析器为我的Rails应用程序生成文档。大多数文档功能开箱即用。但是，我还想将模型属性记录为一个，记录模型上的可用属性列表和两个，以描述它们的语义。我无法在YARD中找到对此的任何特殊支持，我基本上只能在类注释中简单地列出属性。有没有办法记录动态生成的模型属性，以便它们像标准属性/方法一样出现在文档中？附言我已经使用annodate-modelsgem在类列表的顶部生成基本模式转储，但这并不是我真正想要的。 最佳答案 似乎YARD现在有自己的@!attribute(注意感叹号)标签用于此
我在多个位置安装了多个gem。生成/重新生成的困难/简单方法是什么:所有这些已安装的gem的rdoc，一次全部？所有这些已安装的gem的yardoc，一次全部？ 最佳答案 你试过其中之一吗？gemrdoc--allgemrdoc--all--overwrite 关于ruby-如何为所有已安装的gem重建rdoc？，我们在StackOverflow上找到一个类似的问题： https://stackoverflow.com/questions/3152857/
