ruby - 耙场 VS yardoc

Question

我跑步yardoc时和跑步时得到不同的结果rake yard

$ yardoc
Files:         123
Modules:         4 (    0 undocumented)
Classes:       120 (    0 undocumented)
Constants:      11 (    0 undocumented)
Attributes:     16 (    0 undocumented)
Methods:       440 (    0 undocumented)
 100.00% documented

$ rake yard
Files:         123
Modules:         4 (    0 undocumented)
Classes:       120 (    0 undocumented)
Constants:      11 (    0 undocumented)
Attributes:     16 (    0 undocumented)
Methods:       544 (    2 undocumented)
 99.71% documented

我不确定额外的 104 种方法来自哪里，或者其中 2 种方法尚未记录。它来自我的宝石吗？

我试图寻找答案，但没有找到任何东西。有人可以指出我正确的方向来解释这种差异，或者它是否真的很重要？

我也尝试过跑步$ yard --list-nodoc，但它给了我类似的结果$ yardoc；这就是我问的原因。

标签： rubyyardyardoc

Answer 1

YARD README应该包含您需要的信息。特别是，yarddoc 命令“将假定您的文件位于lib/目录中”，但可以在.yardopts 文件中自定义此行为。

同样，rake yard默认情况下会查找匹配的文件lib/**/*.rb，但这可以在 中自定义Rakefile，例如：

require 'yard'

YARD::Rake::YardocTask.new do |t|
  t.files   = ['lib/**/*.rb', OTHER_PATHS]
end

TL;DR：检查项目.yardopts和Rakefile文件。