我有一个小代码库,我正在使用YARD进行记录。当我运行yardoc
命令时,它会告诉我:
Files: 40
Modules: 14 ( 0 undocumented)
Classes: 39 ( 0 undocumented)
Constants: 21 ( 4 undocumented)
Methods: 239 ( 31 undocumented)
88.82% documented
我希望它只是列出未记录的项目,而不是浏览我的所有代码来查找未记录的常量和方法。有谁知道怎么做?
答案 0 :(得分:44)
您可以使用--list-undoc
选项专门列出所有未记录的对象(及其文件位置)。
yard stats --list-undoc
甚至
yard --list-undoc
答案 1 :(得分:25)
这也使我感到困惑。 --list-undoc
选项实际上是在stats
命令下定义的。此外,该命令为yard
而不是yardoc
,这是yard doc
的简写。
yard stats --list-undoc