如果我错了请纠正我，是YARD与RDoc不同？它不是基于RDoc，而是完全重写？所以如果我使用YARD，我就不必为RDoc而烦恼，对吧？ 最佳答案 简而言之:是的。(针对所有三个问题。)请注意，YARD在很大程度上与RDoc向后兼容，至少就标记而言是这样。(RDoc插件OTOH不适用于YARD。)因此，您实际上可以使用YARD来处理遗留RDoc文件。YARD主要是RDoc的适当超集。 关于ruby-YARD和RDoc不一样？，我们在StackOverflow上找到一个类似的问题：
我刚刚开始使用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_
我正在使用YARD来记录我的代码。我有一个方法，它有一个带有默认值的可选参数。如何标记该参数是可选的并具有默认值？例子:#Squaresanumber##@paramthenumbertosquaredefsquare_a_number(number=2)number*numberend 最佳答案 YARD现在自动支持参数默认值。YARD根据方法定义自动计算出默认值。瑞典语!例如，以下代码文档将生成后续的YARD文档:代码文档#Squaresanumber.##@paramnumber[Integer]Thenumbertosqua
我目前正在从rdoc切换到yard以获取我的ruby软件文档。在我的文档中，我经常从评论中引用一些类/模块，例如:##==Providesvariousutilityfeatures####==Features####Logging:loggingisprovidedbytheMysoft::Mypackage::Utility::Loggerclass##Rdoc正确地创建了指向Mysoft::Mypackage::Utility::Logger类文档页面的链接，而yard忽略了标记并将类名视为简单字符串。我知道yard有@see标签，但是这会在文档中创建一个单独的“另见”部分，
我想在我们的Rails应用程序中包含有关Rake任务的信息。我们使用YARD用于文档，目前像lib/tasks/development.rake这样的页面默认显示为未格式化的文本。我可以使用#@markuprubyfromtheYARDdocumentation将它们呈现为Ruby源代码.但是，这只会呈现任何内联注释，即使它们包含像#@!methodfoo这样的YARD指令。这意味着theYARDdocumentationontaggingDSLs似乎不适用。我错过了什么吗？如何让YARD识别.rake文件中的代码与文档？注意我会很高兴有一个忽略实际代码并只生成文档副本的解决方案，
我有一个小型代码库，我正在用YARD记录这些代码.当我运行yardoc命令时，它告诉我:Files:40Modules:14(0undocumented)Classes:39(0undocumented)Constants:21(4undocumented)Methods:239(31undocumented)88.82%documented与其费力地遍历我的所有代码来查找未记录的常量和方法，我希望它简单地列出未记录的项目。有人知道怎么做吗？ 最佳答案 您可以使用--list-undoc选项专门列出所有未记录的对象(及其文件位置)。
我正在寻找可以解释php中的字符串并执行简单数学计算的东西，然后返回关于表达式是真还是假的bool结果。例如:Sue输入“3*{mysalary}/9=10000”PHP将其拆分为两个表达式-explode('=',string);PHP获取我的数据库字段列表，并将任何“{}”分隔的字段替换为数据(类型转换为int)然后PHP计算数学表达式然后php比较左边和右边产生bool结果。这听起来可能很复杂，但只需要非常简单即可。以下是限制条件:1/数学运算符固定为:+-/*2/比较运算符固定为:=>=只会有两个表达式，一个比较运算符。如果有任何类型的错误，我们将返回false。有没有人见过可
如果我在一个文件中有以下内容:moduleSomethingclassResource#Definesanewproperty#@param[String]namethepropertyname#@param[Class]typetheproperty'stype#@macro[attach]property#@return[$2]the$1propertydefself.property(name,type)endendclassPost定义的方法property得到了正确的记录。但是，如果我在单独的文件中有这些定义，则无法正确生成文档，例如以下情况:file0.rb:require
我有一个看起来像这样的方法:defget_endpoint(params:{})end我希望这个方法的调用者能够传入一些可选参数。我想编写YARD文档来支持这一点，如果我不使用关键字参数，我会使用@option声明。但是，YARD自己的文档说:Note:Forkeywordparameters,use@param,not@option.所以我尝试了:#@paramparams[Hash]optionstobeusedinrequest#@paramdate[String]dateinYYYYMMDD#@paramstart_time[Integer]start_timeinEpoch失
