Hoe kan ik de bestaande opmerkingen toevoegen aan RDOC in Ruby?

stemmen
36

Ik wil mijn bestaande opmerkingen opmaken als 'RDOC opmerkingen', zodat ze kunnen worden bekeken met behulp van ri.

Wat zijn de aanbevolen bronnen voor het starten met behulp van RDOC?

De vraag is gesteld op 01/08/2008 om 14:38
bron van user
In andere talen...                            


2 antwoorden

stemmen
9

RDOC gebruikt SimpleMarkup dus het is vrij eenvoudig om lijsten te maken, enz. Met behulp van *, - of een nummer. Het behandelt ook lijnen die tegelijk kolomnummer worden ingesprongen als onderdeel van dezelfde paragraaf totdat er een lege lijn die een nieuwe paragraaf betekent. Heeft u een paar voorbeelden van opmerkingen die u wilt RDoc'ed zodat we konden laten zien hoe je ze moet doen en dan kun je extrapoleren dat voor de rest van uw commentaar?

antwoordde op 02/08/2008 om 11:22
bron van user

stemmen
14

Een paar dingen die me hebben gebeten:

  • :main:- RDOC gebruikt alleen de laatste geëvalueerd; best om ervoor te zorgen dat er slechts één in uw project en u niet ook gebruik maken van --maincommand-line argument.
  • hetzelfde als de vorige, maar voor :title:
  • :section: niet erg goed
antwoordde op 23/08/2008 om 05:48
bron van user

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