Удалить комментарии rubocop из документации Yardoc

Мы используем Yardoc для создания HTML-документации для ряда gems и приложений моей компании. Мы также используем Rubocop для соответствия стилю руководства.

Проблема, с которой я сталкиваюсь, заключается в том, что мы должны включить/отключить некоторые метрики метода и эти комментарии (# rubocop:disable Metrics/AbcSize и т. д...) появляется в нашей документации. Есть ли плагин, который удаляет их или какое-то руководство, которому я могу следовать при создании своего собственного?

1 3
rubocop

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
3