Frage

Wenn ich Reihe von Klassen in Object habe und habe eine Liste von Methoden, die auch von Object erzeugt, gibt es eine Möglichkeit rdoc Dokumentation für einzelne Methode zu holen?

Beispiel:

DATEI: foo.rb

# Class rdoc information here
class foo

  # defining bar here, just prints hello world
  def bar
   puts "hello world"
  end
end

DATEI: baz.rb

require 'foo.rb'
puts "I want to print out the rdoc portion of method bar here"
War es hilfreich?

Lösung

Ich habe eine Arbeit-a-Runde, aber wenn jemand eine bessere Lösung hat, lassen Sie es mich wissen.

Basicly mein foo.rb Skript wird nur ausgeführt, wenn im einige Verpackungs Metadaten zu erzeugen. Und dies wird ausgeführt, einmal pro Compile-Zyklus. Ich habe ein zusätzliches Ziel meiner Make-Datei, die eine lokale ri Dokumentation hält und dann in meinem foo.rb Skript ich nenne nur ri wie folgt aus:

DATEI: baz.rb

myClassName = "foo" 
myMethoedName = "bar"
caseDoc=`ri -f simple -d ../.ri #{myClassName}##{myMethodName} -T`
puts caseDoc
Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top