标准ruby​​onrails项目有README.rdoc。许多githubrails项目都有README.md。有什么区别？ 最佳答案 来自kiddorails的另一个已删除StackOverflow问题的答案片段:RDocisafantastictoolwhichenablestheautomaticgenerationofformattedHTMLcontainingourdocumentedcode.Forexample,mostofgemsonRubyGemsfetchdocumentationandcompilesthe

我刚刚开始使用YARD来记录我的Rails应用程序。我没有指定任何特定的标记处理程序，但我希望`code`会转换为code，但这似乎没有发生。这是正常行为吗？我是否必须添加一些额外的选项才能完成这项工作？谢谢。 最佳答案 我想语法与markdown有点不同(markdownvsrdoc)。使用'+'作品。+code+在中呈现block。 关于ruby-YARD不把`code`替换成code正常吗？，我们在StackOverflow上找到一个类似的问题： htt

对于基本的Ruby方法，我会为以下格式的参数提供YARD样式文档。#@paramquery[String]Thesearchstringtoquery.#@paramoptions[Hash]Optionalsearchpreferences.defsearch(query,options={})#...end在Ruby2.0中，现在可以使用关键字参数。但是，我不确定如何根据YARD文档处理该问题。defsearch(query,exact_match:false,results_per_page:10)#...end在第二种情况下，我将如何记录exact_match和results_

我知道可以在没有文档的情况下安装gem，但不幸的是，我在使用ruby​​的前三个月没有这样做。在那段时间里，我设法安装了大量的gem，但自从我开始使用ruby​​以来，我没有一次使用过计算机上的文档。我总是在互联网上查找文档。从我的计算机中安全删除文档的最佳方法是什么？另外，有没有办法配置ruby​​默认不安装文档？ 最佳答案 运行这个命令:rm-r"$(gemenvgemdir)"/doc/*在Windows上，如果你使用cygwin 关于ruby-如何删除geminstall安装的文

我目前正在从rdoc切换到yard以获取我的ruby​​软件文档。在我的文档中，我经常从评论中引用一些类/模块，例如:##==Providesvariousutilityfeatures####==Features####Logging:loggingisprovidedbytheMysoft::Mypackage::Utility::Loggerclass##Rdoc正确地创建了指向Mysoft::Mypackage::Utility::Logger类文档页面的链接，而yard忽略了标记并将类名视为简单字符串。我知道yard有@see标签，但是这会在文档中创建一个单独的“另见”部分，

这个问题在这里已经有了答案:关闭11年前。社区在上个月审查了是否重新打开此问题并使其关闭:原始关闭原因未解决PossibleDuplicate:ruby1.9riproblem当我尝试在命令提示符窗口中使用Ruby的ri工具来获取有关类、方法等的帮助时，它似乎总是失败。例如，如果我输入:riArray我收到一条消息说:Updatingclasscachewith0classes...NothingknownaboutArray我使用的是安装了Ruby1.9.1p243(2009-07-16修订版24175)[i386-mingw32]的Vista64。我应该如何配置ri才能工作？

我刚刚安装了RVM，并且正在阅读TheWell-GroundedRubyist一书。在第一章中，我应该尝试riString#upcase查看有关upcase方法的文档，但是我收到一条消息:NothingknownaboutString#upcase我在SO上发现一些帖子告诉我这可能是因为未安装RDoc。但是我不明白如何修复它。我正在使用MacOSX10.6和最新的RVM。我只安装了1.9.2，此外还有标准的Ruby解释器，它随Apple的开发工具包一起提供。 最佳答案 您是否生成了文档？rvm文档生成https://rvm.io/r

每当我安装gems时，我都会看到ri和rdoc。我知道这是文档，但两者有什么区别以及如何使用它们？ 最佳答案 RDoc[..]是Ruby编程语言的嵌入式文档生成器。[..]RDoc作为Ruby核心发行版的一部分包含在内。RDoc还提供了创建Rubyri数据文件的引擎。ri(或多或少)是Ruby版本的手册页，从命令行提供API信息。来自:http://en.wikipedia.org/wiki/RDoc 关于ruby-ri和rdoc有什么区别，我们在StackOverflow上找到一个类似

关闭。这个问题不符合StackOverflowguidelines.它目前不接受答案。我们不允许提问寻求书籍、工具、软件库等的推荐。您可以编辑问题，以便用事实和引用来回答。关闭5年前。Improvethisquestion我想将我现有的评论格式化为“RDoc评论”，以便可以使用ri查看它们。开始使用RDoc有哪些推荐资源？

如何删除已安装的gem的ri和rdoc？谢谢 最佳答案 您可以简单地删除RubyGems安装目录中的doc目录。rm-r`gemenvgemdir`/doc在MacOSX上，默认情况下，它是/Library/Ruby/Gems/1.8/doc。请记住，RubyGems可能有多个安装目录。RubyGems将尝试安装到您的用户目录(类似于~/.gem/ruby/1.8/)如果它不能访问正常的安装目录(例如，您安装了一个没有sudo).RVM还会为它安装的每个Ruby安装RubyGems，其中包含一个doc目录，其中包含rdoc和ri文件