Come posso aggiungere commenti esistenti a RDoc in Ruby?[Chiuso]

Question

Desidero formattare i miei commenti esistenti come "commenti RDoc" in modo che possano essere visualizzati utilizzando ri.

Quali sono alcune risorse consigliate per iniziare a utilizzare RDoc?

Answer 1

Alcune cose che mi hanno morso:

• :main: -- RDoc utilizza solo l'ultimo valutato;è meglio assicurarsi che ce ne sia solo uno nel tuo progetto e non utilizzare anche il file --main argomento della riga di comando.
• come il precedente, ma per :title:
• :section: non funziona molto bene

Answer 2

RDoc utilizza SimpleMarkup quindi è abbastanza semplice creare elenchi, ecc.utilizzando *, - o un numero.Tratta anche le righe rientrate con lo stesso numero di colonna come parte dello stesso paragrafo finché non rimane una riga vuota che indica un nuovo paragrafo.Hai alcuni esempi di commenti che desideri RDoc in modo che possiamo mostrarti come eseguirli e poi potresti estrapolarlo per il resto dei tuoi commenti?