如何使用YARD记录Rake任务?

时间:2015-04-22 15:32:57

标签: ruby-on-rails ruby rake yard

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

我可以使用# @markup ruby from the YARD documentation将它们渲染为Ruby源代码。

但是,这只是内联任何注释,即使它们包含# @!method foo等YARD指令。这意味着the YARD documentation on tagging DSLs似乎不适用。

我错过了什么吗?

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

N.B。我很满意忽略实际代码并只生成文档副本的解决方案,但文档副本的来源必须是.rake文件本身 - 我不希望文档存在于单独的{{1}中文件(或其他),因为它太可能失去同步。

更多信息 - .markdown命令:

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

.yardopts

要让YARD阅读Rake任务,我可以在连字符之后添加--asset graphs 'app/**/*.rb' 'lib/**/*.rb' - README info/* (即将Rake文件添加到YARD'文件'列表中),但如上所述,这不是正确处理它们。

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

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

1 个答案:

答案 0 :(得分:1)

来自YARD文档:

使用YARD生成文档下的使用YARD入门指南部分中,查看记录额外文件添加Meta - 数据到额外文件。这可能有所帮助。