Wie füge ich die vorhandenen Kommentare zu RDoc Ruby?[geschlossen]

Question

Ich möchte mein format vorhandene Kommentare wie 'RDoc Kommentare, damit Sie angezeigt werden kann mit ri.

Was sind einige empfohlene Ressourcen für den Start mit RDoc?

Answer 1

Ein paar Dinge, die gebissen haben mich:

• :main: -- RDoc verwendet, wird nur die Letzte Auswertung;beste zu machen sicher, es ist nur eine in Ihrem Projekt, und Sie nicht auch verwenden --main command-line argument.
• gleiche wie vorher, aber für :title:
• :section: funktioniert nicht sehr gut

Answer 2

RDoc verwendet SimpleMarkup es ist also ziemlich einfach zu erstellen, Listen, etc.mit *, - oder eine Nummer.Es behandelt auch Linien, die den Einzug in die gleiche Spalte Anzahl als Teil des gleichen Absatz, bis es eine leere Zeile, was bedeutet, dass Sie einen neuen Absatz.Haben Sie ein paar Beispiele von Kommentaren, die Sie wollen RDoc ' ed so konnten wir zeigen Ihnen, wie Sie zu tun, und dann könnte man extrapolieren, dass es für den rest Ihres Kommentare?