Hat Ruby-Yard haben eine Funktion vergleichbar mit RDoc: include: tag?

Question

RDoc hat die: include: Tag (siehe unten dieser Seite ), die in einer beliebigen Textdatei und das Format stattfinden wird, als ob es eingezogen wurde, wo die enthalten beginnt. Dies ist eine gute Möglichkeit, in Quellcode-Dokumentation Beispiele zu ziehen.

Yard einen ähnlichen Tag oder Funktion haben?

Answer 1

Derzeit YARD unterstützt nur Dokumentation Einbettung von anderem Objekt Docstrings in der Form:

class Foo
  # Docstring here
  def method; end

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

Datei-Aufnahme wurde vage geplant, aber es war nie wirklich vor angefordert, so dass es nicht mit hohen Priorität war. Wenn Sie möchten, um ein Problem öffnen http://github.com/lsegal/yard/issues - wir können sicherstellen, wird sie verfolgt und aufgenommen für die kommende 0.7.0 Release

.