Vă mulțumim pentru susținere

Cum pot adăuga comentarii existente la RDoc în Ruby?

Vreau să formatez comentariile existente ca "comentarii RDoc", astfel încât să poată fi vizualizate folosind ri .

Care sunt câteva resurse recomandate pentru începerea utilizării RDoc?

0
adăugat editat
Priviți Documente
adăugat autor Tobias

2 răspunsuri

Câteva lucruri care m-au mâncat:

  • :main: -- RDoc uses only the last one evaluated; best to make sure there's only one in your project and you don't also use the --main command-line argument.
  • same as previous, but for :title:
  • :section: doesn't work very well
0
adăugat

RDoc folosește SimpleMarkup, deci este destul de simplu să creezi liste etc. utilizând *, - sau un număr. De asemenea, tratează liniile care sunt indentate la același număr de coloană ca parte a aceluiași paragraf până când există o linie goală care semnifică un nou paragraf. Aveți câteva exemple de comentarii pe care doriți ca RDoc'ed să vă arătăm cum să le faceți și apoi să le extrapolați pentru restul comentariilor dvs.?

0
adăugat