ruby - Ruby Yard には RDoc :include: タグに匹敵する機能がありますか?

Question

RDoc には :include: タグ (このページの下部を参照) があり、任意のテキスト ファイルを取り込んで、インクルードが始まる場所でインデントされているかのようにフォーマットします。これは、ドキュメントの例のソース コードを取り込むのに最適な方法です。

Yardにも同様のタグや機能がありますか?

Answer 1

現在、YARD は次の形式の他のオブジェクト docstring からのドキュメントの埋め込みのみをサポートしています。

class Foo
  # Docstring here
  def method; end

  # Here is some more docs and {include:Foo#method}
  def bar; end
end

ファイルのインクルードは漠然と計画されていましたが、これまで実際に要求されたことはなかったため、優先度は高くありませんでした。http://github.com/lsegal/yard/issuesでイシューを開きたい場合は、次の 0.7.0 リリースで追跡および追加されるようにします。