从 Yardoc 文档中删除 rubocop 评论
Remove rubocop comments from Yardoc documentation
我们正在使用 Yardoc 为许多 gem 和我公司的应用程序创建 HTML 文档。我们还使用 Rubocop 来实现样式指南合规性。
我 运行 遇到的问题是我们必须 enable/disable 一些方法指标和那些评论（# rubocop:disable Metrics/AbcSize，等等...）出现在我们的文档中.是否有删除这些的插件或我可以遵循的一些指南来创建我自己的？
要禁止代码中的 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
我们正在使用 Yardoc 为许多 gem 和我公司的应用程序创建 HTML 文档。我们还使用 Rubocop 来实现样式指南合规性。
我 运行 遇到的问题是我们必须 enable/disable 一些方法指标和那些评论（# rubocop:disable Metrics/AbcSize，等等...）出现在我们的文档中.是否有删除这些的插件或我可以遵循的一些指南来创建我自己的？
要禁止代码中的 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