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

Posted 2023-02-16

【中文标题】如何使用 rdoc 列出未记录的模块/类/常量/方法？

【英文标题】：How can I list the undocumented modules/classes/constants/methods with rdoc?

【发布时间】：2016-01-19 17:28:57

【问题描述】：

我有一个使用 RDOC 记录的 Rails 应用程序。当我运行 rake rdoc 命令时，它告诉我：

  Classes:     96 (  6 undocumented)
  Modules:     22 ( 14 undocumented)
  Constants:   12 ( 11 undocumented)
  Attributes:  27 ( 27 undocumented)
  Methods:    545 (532 undocumented)

  Total:      702 (590 undocumented)
  15.95% documented

我想找到未记录的类、模块、常量和方法，所以我希望它简单地列出未记录的项目。有人知道怎么做吗？

【参考方案1】：

如果您将rdoc 作为自己的命令运行，您可以指定各种选项。

在您的情况下，您正在寻找rdoc -C，它是“coverage report”的缩写。

rdoc -h 将列出所有命令行选项。

【讨论】：

对于我的 Rails 项目，我必须修改 Rake 任务并添加 -C 选项。类似于：rdoc.options