Wie kann ich bestehende Kommentare zu RDoc in Ruby?

stimmen
36

Ich mag meine bestehenden Kommentare zu formatieren als ‚RDoc Kommentare‘ , so dass sie mit betrachtet werden ri.

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

Veröffentlicht am 01/08/2008 um 14:38
quelle vom benutzer
In anderen Sprachen...                            


2 antworten

stimmen
14

Ein paar Dinge, die mich gebissen haben:

  • :main:- RDoc verwendet nur die letzten ausgewertet; am besten , um sicherzustellen , gibt es nur eine in Ihrem Projekt und verwenden Sie nicht auch das --mainBefehlszeilenargument.
  • gleich wie zuvor, jedoch für :title:
  • :section: funktioniert nicht sehr gut
Beantwortet am 23/08/2008 um 05:48
quelle vom benutzer

stimmen
9

RDoc verwendet SimpleMarkup so ist es ziemlich einfach ist, Listen zu erstellen, etc. * verwendet wird, - oder eine Nummer. Es behandelt auch Linien, die in der gleichen Spalte Nummer als Teil desselben Absatzes eingerückt werden, bis es eine leere Zeile, die einen neuen Absatz bedeutet. Haben Sie ein paar Beispiele für Kommentare haben Sie RDoc'ed so konnten wir Ihnen zeigen, wie sie tun und dann könnte man, dass für den Rest Ihres Kommentare extrapolieren?

Beantwortet am 02/08/2008 um 11:22
quelle vom benutzer

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more