Was ist das äquivalent von einem Python docstring in Ruby?

In Python, können Sie den Zugriff auf ein Objekt docstring mithilfe obj.__doc__. Was ist die entsprechende Aktion in Ruby?

  • Gut, vielleicht sollte man zuerst Fragen, ob Ruby hat docstrings an alle...
InformationsquelleAutor parzival | 2011-02-15
  1. 19

    Ruby nicht über ein Python - __doc__ entspricht. Sie verwenden oft Rdoc-Format für die Dokumentation.

    InformationsquelleAutor Tarantula
  2. 3

    Leider Ruby nicht über die Python-wie gebaut-in docstrings.

    RDoc sieht schrecklich aus. RDoc ist entworfen, um verarbeitet werden, werden in HTML-format Lesen und in das wir browser. Es ist nicht nur text. Wer mag, Lesen von HTML-ähnlichen source-code? HOF ist besser. Es ist auch TomDoc, die nur plain text. Aber keiner von Ihnen zu vergleichen, um Pythonic docstrings, die z.B. ermöglichen einfache automatische Vervollständigung von python-Konsole benutzen müssen, um eine Verarbeitung tool.

    InformationsquelleAutor hipertracker
  3. 2

    Ich glaube nicht, dass ruby dies unterstützt.

    InformationsquelleAutor Olly
  4. 1

    Ist es einfacher zu dokumentieren, in der Ruby mit Hof, unterstützt verschiedene tags wie :NODOC:

    Dokumentieren Sie Ihren code mit Hof, schreib einfach den Kommentar über deinem code.

    # MyClass.new(...) some comment here
class MyClass
end

# foo("bar")
def foo(bar = nil)
end

    führen yard auf das aktuelle Arbeitsverzeichnis des Projekts, das generiert die $PWD/doc Verzeichnis für Sie mit einem netten Satz von Dokumentationen.

    • Hof ist ein optionaler Weg, es zu tun, aber Rdoc ist der standard, da kommt es mit Ruby.
    InformationsquelleAutor magnifying glass on a square f
Schreibe einen Kommentar