Как вывести имена элементов HTML в документации Yard

Question

Я хотел бы включить некоторые имена элементов HTML, например <label>, в документацию по моему классу ruby, сгенерированную Yard. Но это не работает. Например, предложение

# Returns a <label> field...

становится, после обработки двором

Return a field...

Элемент <label> фактически дословно проходит через Yard, превращая его в браузер в виде необработанного HTML.

Я попытался использовать <label> вместо этого, и это сбежало, поэтому я получил <label> в итоговой документации.

Спасибо!

Answer 1

Двор использует нормальную разметку RDoc по умолчанию:

По умолчанию YARD совместим с тем же синтаксисом RDoc, с которым большинство разработчиков Ruby уже знакомы.

И RDoc имеет это, чтобы сказать :

Установка обратной косой черты перед встроенной разметкой останавливает ее интерпретацию, как я создал таблицу выше:

_italic_::     \_word_ or \<em>text</em>
*bold*::       \*word* or \<b>text</b>
+typewriter+:: \+word+ or \<tt>text</tt>

Это говорит о том, что это:

# Returns a \<label> field...

должно сработать, но это не принесло мне никакой пользы, просто все та же ерунда "передать его в HTML". Однако, добавление <label> в разметку пишущей машинки RDoc привело к чему-то полезному, поэтому попробуйте следующее:

# Returns a +<label>+ field...