jjzjj

Documentation

全部标签

ruby - 用 Yardoc 记录 def_delegators

我有一个使用Forwardable中的def_delegators方法的类模块。我还没有找到获取Yardoc的方法为其输出文档。我试过使用macro但它不会为这些特定方法输出任何内容(文件中的其他一切都很好,并且没有错误),而且我有几个不同长度的def_delegators。例如classAextendForwardable#othercode…#@!macro#@seeArray#$1#@seeArray#$2#@seeArray#$3def_delegators:@xs,:size,:是否有gem或方法可以避免尝试编写Yard扩展? 最佳答案

ruby - 用 YARD 记录 "splatted"参数的最佳方法?

关闭。这个问题是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语法记

ruby-on-rails - YARD:如何创建指向类方法的链接?

如何使用YARD创建指向ruby​​类方法的链接?这是yarddocumentation关于链接。链接到同一命名空间内的实例方法:{#my_instance_method}效果很好。但是,使用类方法遵循相同的方法并不能编译,修改它:{#self.my_class_method}生成以下纯文本(不是链接):ObjectName#self#self.my_class_method 最佳答案 只用名字,裸:{class_method}或者如果它在不同的命名空间中{Object.class_method}

c - Ruby 解释器的嵌入 API 的文档在哪里?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭5年前。Improvethisquestion我正在寻找有关将Ruby解释器嵌入到C或C++程序以及用于该目的的API的全面的在线文档资源。Pickaxe书中关于此的部分非常好,但我的版本指的是Ruby1.8,我对当前的ruby​​版本范围很感兴趣,即1.8.x、1.9.x和2.0,并且有很多跨该版本范围的嵌入处理之间的差异。作为引用,有问题的Ruby解释器是来自http://www.ruby-lang.org/

Ruby 核心文档质量

关闭。这个问题需要detailsorclarity.它目前不接受答案。想改进这个问题吗?通过editingthispost添加细节并澄清问题.关闭4年前。Improvethisquestion我是Ruby的新手,时间有限,因此我尝试了一些简单的东西。最近我需要创建一个文件,因为我太懒了,所以我跑去谷歌。结果:File.open(local_filename,'w'){|f|f.write(doc)}真可惜,这很简单,我应该自己做的。然后我想检查File类的方法提供了什么ruby​​魔法,或者在调用这些方法时是否有任何“简化”,所以我前往文档here,并检查文件类。1.8.6文档在"fi

ruby - 使用 Cucumber 或 RSpec+Selenium 创建最终用户文档?

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题,以便用事实和引用来回答。关闭4年前。Improvethisquestion有没有人尝试从您的cucumber场景中创建最终用户(可能在线,可能打印)帮助/文档?或者使用RSpec和SeleniumRC的功能截取屏幕截图以用于文档?对于Cucumber,我想象的是这样的:Scenario:IfyouwanttoaddalinkGivenIamontheeditblogpostpageWhenIpressthe"addlink"buttonAn

ruby-on-rails - 请向我推荐一些需要编写文档/测试的 rails/ruby 开源代码

关闭。这个问题不符合StackOverflowguidelines。它目前不接受答案。要求我们推荐或查找书籍、工具、软件库、教程或其他场外资源的问题对于StackOverflow来说是偏离主题的,因为它们往往会吸引自以为是的答案和垃圾邮件。相反,请描述问题以及迄今为止为解决该问题所做的工作。关闭8年前。Improvethisquestion在过去的4个月左右的时间里,我一直在使用ruby​​onrails,我真的很喜欢开源的整个概念。我知道它不是ruby​​/rails独有的,但来自Windows编程,这是我第一次真正接触它。我想尽我所能“回馈”,但我觉得我无法贡献任何有值(value

ruby - 如何使用 Doxygen 记录 Ruby 代码?

问题:如何使用Doxygen记录Ruby代码?免责声明:我知道ruby​​已经有一个内置的文档系统,可能还有其他方法可以做到这一点,但我操作的具体限制是如何让Doxygen完成这项工作(假设它是可能的). 最佳答案 简短的回答,没有。长答案,仍然没有。Doxygen最终会用于Ruby,但我不认为它会很快发生。短期内,您只能使用RDoc或YARD。 关于ruby-如何使用Doxygen记录Ruby代码?,我们在StackOverflow上找到一个类似的问题: h

ruby - 使用 YARD 记录模型属性

我正在使用YARD使用makrdown作为脚本解析器为我的Rails应用程序生成文档。大多数文档功能开箱即用。但是,我还想将模型属性记录为一个,记录模型上的可用属性列表和两个,以描述它们的语义。我无法在YARD中找到对此的任何特殊支持,我基本上只能在类注释中简单地列出属性。有没有办法记录动态生成的模型属性,以便它们像标准属性/方法一样出现在文档中?附言我已经使用annodate-modelsgem在类列表的顶部生成基本模式转储,但这并不是我真正想要的。 最佳答案 似乎YARD现在有自己的@!attribute(注意感叹号)标签用于此

ruby-on-rails - 在哪里定义 Rails 应用程序的版本号

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题?更新问题,以便editingthispost可以用事实和引用来回答它.关闭5年前。Improvethisquestion关于如何/在何处指定应用程序的版本号是否有任何约定?例如,对于ruby​​gems,lib/mygem/version.rb是通常用于该目的的文件。我的猜测是像这样创建config/version.rb文件:moduleMySiteVERSION="0.0.4"#orinMySite::Applicationclass##classApplication#VERSION="0.0.4"#e