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

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

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

推荐答案

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

yard stats --list-undoc

甚至

yard --list-undoc

Ruby相关问答推荐

数组上的Ruby#unionreact 非常奇怪

应用 ransack 日期字段过滤器后,相同的输出票证重复而不是一张

环绕分隔线,保留第一列,最小最终长度

Python 正则表达式是否等同于 Ruby 的原子分组?

将数组转换为哈希,其中键是索引

Ruby |= 赋值运算符

在 MacOS Sierra 上使用 RMagick 2.16 的 ImageMagick 7 找不到 MagickWand.h

Integer(value) 和 value.to_i 之间的区别

如何调试/显示使用 RestClient 发送的请求

如何在 ruby​​ 中编写负循环,例如 for(i=index; i >= 0; i --)

在 ruby​​ 中访问嵌套哈希的元素

与 String 相比,在 Ruby 中使用 StringIO 有哪些优势?

Ruby中的常量或类变量?

从 1 开始循环

Ruby注入初始为哈希

Ruby中的每个块都可以有一行吗?

在 Ruby 中取消定义变量

如何在 Ruby 中找到除法的余数?

使用 `?`(问号)在 Ruby 中获取 ASCII 字符代码失败

在ruby中将字符串转换为十进制数