草庐IT

ruby - 用 Yardoc 记录 def_delegators

我有一个使用Forwardable中的def_delegators方法的类模块。我还没有找到获取Yardoc的方法为其输出文档。我试过使用macro但它不会为这些特定方法输出任何内容(文件中的其他一切都很好,并且没有错误),而且我有几个不同长度的def_delegators。例如classAextendForwardable#othercode…#@!macro#@seeArray#$1#@seeArray#$2#@seeArray#$3def_delegators:@xs,:size,:是否有gem或方法可以避免尝试编写Yard扩展? 最佳答案

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

我有一个小型代码库,我正在用YARD记录这些代码.当我运行yardoc命令时,它告诉我:Files:40Modules:14(0undocumented)Classes:39(0undocumented)Constants:21(4undocumented)Methods:239(31undocumented)88.82%documented与其费力地遍历我的所有代码来查找未记录的常量和方法,我希望它简单地列出未记录的项目。有人知道怎么做吗? 最佳答案 您可以使用--list-undoc选项专门列出所有未记录的对象(及其文件位置)。

ruby - 从 Yardoc 文档中删除 rubocop 注释

我们正在使用Yardoc为许多gems和我公司的应用程序创建HTML文档。我们还使用Rubocop来实现样式指南合规性。我遇到的问题是我们必须启用/禁用一些方法指标和那些注释(#rubocop:disableMetrics/AbcSize等...)出现在我们的文档。是否有删除这些的插件或我可以遵循的一些指南来创建我自己的? 最佳答案 要禁止代码中的rubocop指令出现在YARDOC文档中,请在注释后插入换行符。例如#rubocop:disableMetrics/AbcSize#Convertstheobjectintotextua