从 Yardoc 文档中删除 rubocop 注释答案

【问题标题】：Remove rubocop comments from Yardoc documentation从 Yardoc 文档中删除 rubocop 注释
【发布时间】：2018-03-05 20:18:14
【问题描述】：

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

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

【问题讨论】：

如果我理解正确，您只想为某些方法禁用这些指标。您可以尝试将这些方法提取到单独的模块/文件中，然后通过 .rubocop.yml 文件忽略该文件。这样您就不需要在代码中添加 # rubocop:disable 注释。
这些方法可能应该保留在原来的位置。我认为仅仅为了满足 rubocop 而提出一种方法会很奇怪。
假设您将 # rubocop:disable 放在方法的文档 cmets 之前，您可以尝试在此行之后插入一个额外的换行符吗？这能解决你的问题吗？
@sxm1972 成功了！谢谢！
太棒了。在这种情况下，请将我的答案标记为正确答案。这将有助于结束这个问题并帮助其他人提供书面答案。

标签： ruby rubocop yardoc

【解决方案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

【讨论】：