Question

我们正在使用Yardoc为许多宝石和我公司的应用程序创建HTML文档。我们也使用Rubocop来确保风格指南的合规性。

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

Answer 1

要禁用代码中的rubocop指令，使其不出现在YARDOC文档中，请在注释后插入换行符。 e.g。

# 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

从Yardoc文档中删除rubocop注释

1 个答案: