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

标签 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

与其费力地遍历我的所有代码来查找未记录的常量和方法,我希望它简单地列出未记录的项目。有人知道怎么做吗?

最佳答案

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

yard stats --list-undoc

甚至

yard --list-undoc

关于ruby - 如何使用 yardoc 列出未记录的模块/类/常量/方法?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5756919/

相关文章:

doxygen+sphinx(breathe) 用于文档

documentation - 如何使用 aws cdk 记录 rest api

documentation - 如何在 Doxygen 中使用与安装选项交互的条件

php - 还有什么比 PHPDoc 更好的吗?

ruby-on-rails - 神秘的 Ruby block 行为 : &block vs. {block.call}

不使用 readthedocs 和 sphinx 呈现的 Python 代码块

ios - 如何自定义Doxygen生成的文档?

ruby - 访问任意深度的嵌套哈希值的最像 ruby​​ 的方法是什么?

Ruby 选项解析器。这段代码是否更简洁?

ruby - 是否可以在 Ruby 中声明类型?