rdoc, darkfish und: Anruf-Seq: tag

Question

Ich bin in den Prozess ein Ruby-Projekt mit rdoc zu dokumentieren, und ich entdeckte die darkfish rdoc Formatierer. Ich mag es, aber der :call-seq: Tag nicht mehr funktioniert. Stattdessen setzt er die Zeichenkette :call-seq: in der Dokumentation und formatiert dann die Aufrufreihenfolge selbst als Codeblock. Ich will nicht nur nehmen alle die: Call-Seq: Blöcke meines Codes aus, da ein großer Teil meiner Dokumentation Bedürfnisse Instanznamen und Parameternamen im :call-seq: Block gegeben zu verweisen. Hat jemand dieses Problem gehabt? Was soll ich tun, und gibt es eine Abhilfe? Ich bin ziemlich sicher, dass der :call-seq: Tag arbeitet vor, als ich das Standard-Formatierungsprogramm, aber ich kann nicht sicher sein, weil ich kann nicht herausfinden, wie ohne Argumente außer Dateien zu erzeugen, das ursprüngliche Format (Aufruf rdoc zurück zu gehen erzeugt nun darkfish Ausgang, auch wenn ich den Ordner doc!) Wer weiß, löschen, wie dieses Problem beheben?

Answer 1

Ich empfehle von rdoc Umzug nach YARD . Es unterstützt nicht den alten Anruf-Seq selbst, sondern es hat Tags und vor allem die @ Überlastung Tag wird kranial Anruf-Seq ersetzen. Die gesamte Dokumentation auf rubydoc.info wird auch mit YARD erzeugt wird.

Hier ist das Beispiel für @overload aus der YARD Dokumentation:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end