如何使用YARD记录Rake任务？

Question

我想在Rails应用程序中包含有关Rake任务的信息.我们使用YARD作为文档,目前页面lib/tasks/development.rake默认显示为无格式文本.

我可以使用# @markup ruby YARD文档中的 Ruby源代码进行渲染.

但是,这只是内联任何注释,即使它们包含YARD指令# @!method foo.这意味着有关标记DSL的YARD文档似乎不适用.

我错过了什么吗？

如何让YARD识别文件中的代码与文档.rake？

NB我会很高兴一个忽略实际代码并只生成文档副本的解决方案,但文档副本的来源必须是.rake文件本身 - 我不希望文档存在于单独的.markdown文件(或其他任何)中,因为它也是很有可能它失去同步.

更多信息 - yard命令:

我正在使用.yardopts包含以下内容的文件:

--asset graphs 'app/**/*.rb' 'lib/**/*.rb' - README info/*

要让YARD读取Rake任务,我可以'lib/tasks/*.rake' 在连字符后添加(即将Rake文件添加到YARD'文件'列表中),但如上所述,这不能正确处理它们.

根据Benjamin在下面的建议,我尝试'lib/tasks/*.rake' 在连字符之前添加(即将 Rake文件添加到要处理的常规Ruby文件列表中),但这似乎根本不会生成任何内容.

YARD可能会产生一些东西,但不是在预期的位置/我想要的预期文件名,我不太熟悉YARD如何确定某个地方是否有孤立的输出.在YARD生成的搜索中肯定没有任何合适的内容,而且简单find doc | grep rake或find doc | grep basename_of_rake_file不显示任何内容.

Answer 1

来自YARD文档：

在YARD 入门指南部分中的使用 YARD 生成文档下，查看 记录额外文件或将元数据添加到额外文件。这可能有帮助。