Создание пользовательских YARD уценки
У меня есть следующий метод, который я хотел бы документировать, используя YARDoc
,
# Here is my method
# @arg woop [Woop] *dangerous* this parameter is output to the screen
def shoop(woop)
puts woop
end
Это генерирует HTML где dangerous
выделено жирным шрифтом Поскольку я должен анализировать этот вывод, я хотел бы иметь собственный тег HTML. Другими словами, я хотел бы сделать так, чтобы при анализе следующего комментария кода YARDoc
, слово dangerous
окружен <div class="custom"></div>
теги, а не <b><\b>
теги, сделать намного проще разобраться с Nokogiri. Нельзя сказать, что в настоящее время невозможно разобраться с Nokogiri, это просто немного более неловко и уязвимо для изменений в коде YARD.
# Here is my method
# @arg woop [Woop] **dangerous** this parameter is output to the screen
def shoop(woop)
puts woop
end
Есть ли какая-либо функциональность в YARD, которая позволяет мне это сделать? Я посмотрел на создание пользовательских шаблонов, но, похоже, это больше касается анализа кода. Затем я проверил создание пользовательского шаблона уценки, но не увидел, как это можно или нужно сделать. У меня начинает складываться впечатление, что я лаю не на том дереве и был бы признателен, если бы мне бросили ключевое слово Google.
Почему я пытаюсь разобрать HTML в первую очередь:
Как я уже описывал в предыдущих вопросах, я пытаюсь определить интерфейс без дублирования кода. В этом примере я хочу, чтобы сервер "вызывал" опасный метод иначе, чем метод, который не опасен.
1 ответ
Уценка позволяет вам включить встроенный HTML. Так что, возможно, попробуйте:
# Here is my method
# @arg woop [Woop] <div class="custom">dangerous</div> this ....
def shoop...
...
Если это работает, вы можете переопределить CSS по умолчанию в doc/css/common.css
файл.