如何使用yardoc列出未记录的模块/类/常量/方法？
我有一个小代码库，使用YARD进行文档记录。当我运行yardoc命令时，它告诉我：Files: 40 Modules: 14 ( 0 undocumented) Classes: 39 ( 0 undocumented) Constan...
使用YARD将参数标记为可选（或具有默认值）
我正在使用YARD来文档化我的代码。 我有一个带有默认值的可选参数方法。 如何注明该参数是可选的且具有默认值？ 示例: # Squares a number # # @param the number to square def square_a_number(number = 2) ...
如何使用YARD记录Rake任务？
我希望在我们的Rails应用程序中包含关于Rake任务的信息。我们使用YARD进行文档编写，但目前像lib/tasks/development.rake这样的页面默认显示为未格式化文本。 我可以使用来自YARD文档的# @markup ruby将它们呈现为Ruby源代码。 然而，这只是将任...
院子和文档中类/模块的链接
我目前正在将我的Ruby软件文档从rdoc切换到yard。 在我的文档中，我经常在注释中引用一些类/模块，例如：## == Provides various utility features ## ## == Features ## ## Logging : logging is provi...
如何为Ruby关键字参数提供YARD/RDoc文档？
对于一个基本的 Ruby 方法，我会按照以下格式针对参数提供 YARD 风格的文档。# @param query [String] The search string to query. # @param options [Hash] Optional search preferences. ...
YARD和RDoc不是同一个东西吗？
请纠正我如果我错了，YARD和RDoc不是同一个东西吧？ 它不是基于RDoc而是完全重写的吗？ 所以如果我在使用YARD，就不需要再去烦恼RDoc了对吧？
YARD不用<code>code</code>替换`code`是正常的吗？
我刚开始使用YARD记录我的Rails应用程序。我没有指定任何特定的Markup处理程序，但我本来希望`code`会被转换为code，但似乎并没有发生。这是正常行为吗？我需要添加一些额外的选项才能使其工作吗？谢谢。
使用YARD记录文档模型属性
我正在使用YARD来生成我的Rails应用程序文档，使用makrdown作为脚本解析器。大多数文档功能都可以直接使用，非常好用。不过，我也想记录模型属性: 一是记录模型上可用属性的列表；二是描述它们的语义含义。 在YARD中，我没有找到任何特殊支持，只能在类注释中列出属性。有没有一种方法可以...
如何重新构建所有安装的宝石的rdoc？
我在多个位置安装了几个 gem。 如何以简单/困难的方式一次性生成/重新生成： 所有已安装 gem 的 rdoc？ 所有已安装 gem 的 yardoc？
PEG语法和解析器生成器的限制是什么？
我很喜欢使用YARD： http://www.ootl.org/yard/ http://code.google.com/p/yardparser/ http://www.codeproject.com/KB/recipes/yard-tokenizer.aspx 我能够构建出一个完全...