我正在为正确的RDoc语法寻找一个好的,可靠的参考.建议？我似乎无法找到任何清楚显示的内容:
我想将现有注释格式化为"RDoc注释",以便可以使用它们进行查看ri.
开始使用RDoc有哪些推荐的资源？
我刚刚安装了RVM,而且我正在阅读The Well-Grounded Rubyist一书.在第一章中,我应该尝试ri String#upcase查看关于upcase方法的文档,但是我收到一条消息说:
没有人知道String#upcase
我在这里发现了一些帖子告诉我这可能是因为没有安装RDoc.但是我不明白如何解决它.
我使用的是Mac OSX 10.6和最新的RVM.除了标准的Ruby解释器以及Apple的Developer工具包之外,我只安装了1.9.2.
可能重复:
ruby 1.9 ri问题
当我尝试ri在命令提示符窗口中使用Ruby的工具来获取有关类,方法等的帮助时,它似乎总是失败.例如,如果我键入:
ri Array
我收到一条消息说:
Updating class cache with 0 classes... Nothing known about Array
我正在使用Vista 64与Ruby 1.9.1p243(2009-07-16修订版24175)[i386-mingw32]安装.
我应该怎么做才能配置 ri工作？
我正在从rdoc切换到yard用于我的ruby软件文档.
在我的文档中,我经常从注释中引用一些类/模块,例如:
## == Provides various utility features
##
## == Features
##
## Logging : logging is provided by the Mysoft::Mypackage::Utility::Logger class
##
Rdoc正确创建了一个指向Mysoft :: Mypackage :: Utility :: Logger类文档页面的链接,而yard忽略了标记并将类名视为简单字符串.
我知道院子里有@see标签,但是这会在文档中创建一个单独的"See Also"部分,而我需要在我的描述文本中引用类/模块.
我肯定错过了一些东西,但如果你有任何关于如何用院子做的例子,我真的很感激.
谢谢你的推荐,
DL
我知道可以在没有文档的情况下安装宝石,但不幸的是,我在前三个月没有使用ruby.在那个时候,我设法安装了大量的宝石,但是自从我开始使用ruby以来我没有使用过我的计算机上的文档.我总是在互联网上查看文档.
从我的计算机安全删除文档的最佳方法是什么？另外,有没有办法将ruby配置为默认不安装文档？
对于基本的Ruby方法,我将以下列格式为参数提供YARD样式doc.
# @param query [String] The search string to query.
# @param options [Hash] Optional search preferences.
def search(query, options = {})
# ...
end
使用Ruby 2.0,现在可以使用关键字参数.但是,我不确定如何在YARD文档方面采用这种方法.
def search(query, exact_match: false, results_per_page: 10)
# ...
end
如何将我的文件exact_match,并results_per_page在第二个方案？我应该继续使用@param关键字,还是有更好的东西？
我刚刚开始使用YARD来记录我的Rails应用程序.我没有指定任何特定的标记处理程序,但我希望将`code`转换为code,似乎不会发生.这是正常的行为吗？我是否需要添加一些额外的选项才能使其正常工作？谢谢.