如何使用yardoc列出未记录的模块/类/常量/方法?

Jef*_*.D. 41 ruby documentation documentation-generation yard

我有一个小代码库,我正在用YARD记录.当我运行yardoc命令时,它告诉我:

Files:          40
Modules:        14 (    0 undocumented)
Classes:        39 (    0 undocumented)
Constants:      21 (    4 undocumented)
Methods:       239 (   31 undocumented)
 88.82% documented
Run Code Online (Sandbox Code Playgroud)

我希望它只是列出未记录的项目,而不是浏览我的所有代码来查找未记录的常量和方法.有人知道怎么做吗?

Vas*_*ich 44

您可以使用该--list-undoc选项专门列出所有未记录的对象(及其文件位置).

yard stats --list-undoc
Run Code Online (Sandbox Code Playgroud)

甚至

yard --list-undoc
Run Code Online (Sandbox Code Playgroud)


小智 26

这也困惑了我.该--list-undoc选项实际上是在stats命令下定义的.而且,命令yard不是yardoc,而是简写yard doc.

yard stats --list-undoc
Run Code Online (Sandbox Code Playgroud)