Hoe voeg ek die bestaande kommentaar te RDoc in Ruby?[gesluit]

Question

Ek wil om die formaat van my bestaande kommentaar as "RDoc kommentaar" sodat hulle kan gesien word met behulp van ri.

Wat is'n paar aanbevole hulpbronne vir begin met behulp van RDoc?

Answer 1

'n paar dinge wat my gebyt:

• :main: -- RDoc gebruik slegs die laaste een geëvalueer word;beste om seker te maak daar is net een in jou projek en jy nie ook gebruik maak van die --main command line argument.
• dieselfde as die vorige, maar vir :title:
• :section: nie baie goed werk

Answer 2

RDoc gebruik SimpleMarkup so dit is redelik maklik om te skep lyste, ens.met behulp van *, - of'n nommer.Dit behandel ook lyne wat ingekeep by die dieselfde kolom nommer as deel van die dieselfde paragraaf totdat daar is'n leë lyn wat dui op'n nuwe paragraaf.Het jy'n paar voorbeelde van die kommentaar wat jy wil RDoc'ed so kan ons wys jou hoe om dit te doen en dan kan jy ekstrapoleer dat vir die res van jou kommentaar?