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

Question

我们正在使用 Yardoc 为许多 gem 和我公司的应用程序创建 HTML 文档。我们还使用 Rubocop 来实现风格指南合规性。

我遇到的问题是我们必须启用/禁用一些方法指标和那些# rubocop:disable Metrics/AbcSize出现在我们文档中的注释（等）。是否有一个插件可以删除这些或一些我可以遵循的指南来创建我自己的？

Answer 1

要禁止代码中的 rubocop 指令出现在 YARDOC 文档中，请在注释后插入换行符。例如

# rubocop:disable Metrics/AbcSize

# Converts the object into textual markup given a specific format.
#
# @param format [Symbol] the format type, `:text` or `:html`
# @return [String] the object converted into the expected format.
def to_format(format = :html)
  # format the object
end