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

StackOverflow https://stackoverflow.com/questions/4501625

  •  12-10-2019
  •  | 
  •  

質問

rdocには以下があります:tag(の下部を参照してください このページ)それは、含まれる内容がどこからでもインデントされているかのように、任意のテキストファイルと形式を取ります。これは、ドキュメントの例のためにソースコードを取り込むのに最適な方法です。

します ヤード 同様のタグや機能がありますか?

役に立ちましたか?

解決

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

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リリースのために追跡および追加されることを確認できます。

ライセンス: CC-BY-SA帰属
所属していません StackOverflow
scroll top