我想在我们的Rails应用程序中包含有关Rake任务的信息。我们使用YARD作为文档，目前默认情况下，诸如lib/tasks/development.rake之类的页面以无格式文本显示。
我可以使用# @markup ruby from the YARD documentation将它们呈现为Ruby源代码。
但是，即使它们包含YARD指令(例如# @!method foo)，这也只会内嵌任何注释。这意味着the YARD documentation on tagging DSLs似乎不适用。
我想念什么吗？
如何让YARD识别.rake文件中的代码与文档？
N.B.我对忽略实际代码而只生成文档副本的解决方案感到满意，但是文档副本的来源必须是.rake文件本身–我不希望文档存在于单独的.markdown文件(或其他内容)中，因为失去同步的机会太大。
更多信息-yard命令:
我正在使用包含以下内容的.yardopts文件:
--asset graphs 'app/**/*.rb' 'lib/**/*.rb' - README info/*
为了让YARD读取Rake任务，我可以在连字符后添加
'lib/tasks/*.rake'(即，将Rake文件添加到YARD"file"列表中)，但是如上所述，这不能正确处理它们。根据本杰明的以下建议，我尝试在连字符前添加
'lib/tasks/*.rake'(即，将Rake文件添加到要处理的常规Ruby文件列表中)，但这似乎根本不会产生任何结果。YARD可能会生成某些内容，但未在预期的位置生成/不会生成预期的文件名，我对YARD的工作方式不甚了解，以了解某个地方是否存在孤立输出。 YARD生成的搜索中肯定没有合适的内容，并且简单的
find doc | grep rake或find doc | grep basename_of_rake_file不会显示任何内容。 最佳答案
从YARD文档中:
在下的使用yard生成文档的带有YARD的入门指南部分中， checkout 记录额外文件的文档或将元数据添加到额外文件。这可能会有所帮助。