YardのドキュメントでHTML要素名を出力する方法

Question

Yardによって生成されたRubyクラスのドキュメントに、<label>などのHTML要素名を含める必要があります。しかし、それは動作していません。例えば、文

# Returns a <label> field... 

となり、ヤード

Return a field... 

による処理後<label>要素は、実際に生のHTMLとしてブラウザにそれを作る庭を通してそのまま通過しています。

私は<label>を代わりに使用しようとしましたが、それがエスケープされたので、結果として得られたドキュメントで<label>となりました。

ありがとうございます！

Answer 1

ヤードは、デフォルトでは、通常のRDoc markupを使用しています。デフォルトでは

、YARDはほとんどのRubyの開発者が使い慣れた同じRDocの構文と互換性があります。

そしてRDoc has this to say：インラインマークアップは、私は上記の表を作成する方法である、それは解釈されて停止する前にバックスラッシュを置く

：

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

、この示唆：

を

# Returns a \<label> field... 

はうまくいくはずですが、それは私にとって何の役にも立たず、同じことをHTMLに渡すだけです。

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