Est-ce que Ruby cour ont une fonction comparable à RDoc: inclure: tag?

Question

RDoc a: inclure: tag (voir le bas de cette page ) qui prendra dans un fichier texte arbitraire et le format comme si elle était en retrait où l'include commence. Ceci est une excellente façon de tirer dans le code source des exemples de documentation.

cour ont une étiquette similaire ou fonctionnalité?

Answer 1

Actuellement YARD ne supporte que l'intégration d'autres documents docstrings objet sous la forme:

class Foo
  # Docstring here
  def method; end

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

inclusion de fichier a été vaguement prévu, mais il n'a jamais été vraiment demandé avant, donc il n'a pas été une priorité élevée. Si vous voulez ouvrir un problème sur http://github.com/lsegal/yard/issues - nous pouvons assurer qu'il est suivi et a ajouté pour la prochaine version 0.7.0

.