tag - Wie füge ich vorhandene Kommentare zu RDoc in Ruby hinzu?




title-tag (2)

Ich möchte meine vorhandenen Kommentare als 'RDoc-Kommentare' formatieren, damit sie mit ri angezeigt werden können.

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


RDoc verwendet SimpleMarkup, so dass es ziemlich einfach ist, Listen usw. mit *, - oder einer Zahl zu erstellen. Es behandelt auch Zeilen, die mit der gleichen Spaltennummer als Teil desselben Absatzes eingerückt werden, bis eine leere Zeile vorhanden ist, die einen neuen Absatz kennzeichnet. Haben Sie ein paar Beispiele für Kommentare, die Sie RDoc möchten, damit wir Ihnen zeigen können, wie Sie sie ausführen können, und dann könnten Sie das für den Rest Ihrer Kommentare extrapolieren?


Ein paar Dinge, die mich gebissen haben:

  • :main: - RDoc verwendet nur den zuletzt ausgewerteten Wert; Am besten stellen Sie sicher, dass es nur einen in Ihrem Projekt gibt und Sie auch nicht das Kommandozeilenargument --main .
  • wie vorher, aber für :title:
  • :section: funktioniert nicht sehr gut




rdoc