Hvordan legger jeg til eksisterende kommentarer til RDoc i Ruby?

stemmer
38

Jeg ønsker å formatere mine eksisterende kommentarer som RDoc kommentarfeltet, slik at de kan vises ved hjelp ri.

Hva er noen anbefalte ressurser til å starte opp ved hjelp RDoc?

Publisert på 01/08/2008 klokken 13:38
kilden bruker
På andre språk...                            


2 svar

stemmer
14

Et par ting som har bitt meg:

  • :main:- RDoc bruker bare den siste evaluert; beste for å sørge for at det er bare én i prosjektet og du ikke også bruke --mainkommandolinjeargument.
  • samme som tidligere, men for :title:
  • :section: ikke fungerer svært godt
Svarte 23/08/2008 kl. 04:48
kilden bruker

stemmer
9

RDoc bruker SimpleMarkup så det er ganske enkelt å lage lister, etc. med *, - eller et tall. Den behandler også linjer som er innrykket i samme kolonne nummer som del av det samme avsnitt inntil det er en tom linje som betegner et nytt avsnitt. Har du noen eksempler på kommentarer du vil RDoc'ed slik at vi kan vise deg hvordan du gjør dem, og deretter kan du utlede at for resten av dine kommentarer?

Svarte 02/08/2008 kl. 10:22
kilden bruker

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