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

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

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


ruby rubocop yardoc
person HMCFletch    schedule 05.03.2018    source источник
comment
Если я правильно понимаю, вы хотите отключить эти метрики только для определенных методов. вы можете попытаться вытащить эти методы в отдельный модуль/файл, а затем игнорировать этот файл через файл .rubocop.yml. Таким образом, вам не нужно иметь комментарий # rubocop:disable в коде.   -  person sxm1972    schedule 06.03.2018
comment
Методы, вероятно, должны оставаться там, где они есть. Я думаю, было бы странно вытащить один метод только для того, чтобы удовлетворить rubocop.   -  person HMCFletch    schedule 06.03.2018
comment
Предполагая, что вы помещаете # rubocop:disable перед комментариями документации к методу, можете ли вы попробовать вставить дополнительную новую строку после этой строки? это решает вашу проблему?   -  person sxm1972    schedule 08.03.2018
comment
@sxm1972 sxm1972 Это помогло! Спасибо!   -  person HMCFletch    schedule 09.03.2018
comment
Большой. Пожалуйста, отметьте мой ответ как правильный ответ в этом случае. Это помогло бы закрыть этот вопрос, а также помочь другим получить задокументированный ответ.   -  person sxm1972    schedule 12.03.2018

Ответы (1)


arrow_upward
4
arrow_downward

Чтобы директивы 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
person sxm1972    schedule 12.03.2018