yardoc - Online în cloud

PROGRAM:

NUME

yardoc - Instrument Ruby pentru a genera documentație pentru limbajul de programare Ruby

REZUMAT

yarddoc [Opțiuni] [fișiere sursă [- extra_files]] curte medic [Opțiuni] [fișiere sursă [-
extra_files]]

DESCRIERE

curte(1) este un instrument extensibil de generare a documentației pentru limbajul de programare Ruby.
Acesta permite utilizatorului să genereze documentație consistentă, utilizabilă, care poate fi exportată într-un
număr de formate foarte ușor și, de asemenea, acceptă extinderea pentru construcții Ruby personalizate, cum ar fi
ca definiții personalizate la nivel de clasă.

yardoc, sinonim pentru curte medic generează documentația din lista de fișiere sursă. Dacă
această listă este omisă, se folosește „{lib,app}/**/*.rb ext/**/*.c”.

Un set de bază de opțiuni poate fi specificat prin adăugarea unui .yardopts fișier la calea de bază
care conține toate opțiunile suplimentare separate prin spații albe.

OPŢIUNI

General Opţiuni
-b, --db FILE
Utilizați un .yardoc db specificat pentru a încărca de la sau pentru a salva în (implicit la .yardoc)

--[nO-]single-db
Dacă obiectele cod ar trebui să fie stocate într-un singur fișier de bază de date (avansat)

-n, --fără-ieșire
Generați doar baza de date .yardoc, fără documentație.

-c, --use-cache [FILE]
Utilizați .yardoc db stocat în cache pentru a genera documentație (implicit nu este cache)

--fără-cache
Ștergeți .yardoc db înainte de a analiza sursa.

--[nO-]yardopts [FILE]
Dacă argumentele ar trebui citite din FILE (implicit la yes, FILE implicit la .yardopts)

--[nO-]document
Dacă argumentele ar trebui citite din fișierul .document (implicit este da)

--nu-salvare
Nu salvați datele analizate în yardoc db

--exclude regexp
Ignorează un fișier dacă se potrivește cu potrivirea căii (regexp)

producție Opțiuni
--un-dosar
Generează rezultate ca un singur fișier

--listă
Listează obiectele la standard out (implică -n)

--nu-public
Nu arătați metode publice. (implicit afișează public)

--protejat
Afișați metode protejate. (ascunsele implicite sunt protejate)

--privat
Afișați metode private. (implicit ascunde privat)

--nu-privat
Ascundeți obiectele cu eticheta @private

--[no-]api API
Generează documentația pentru un anumit API (obiecte care definesc eticheta @api corectă).
If --no-api este dat, afișează obiecte fără etichetă @api.

--incorpora-mixine
Încorporează metodele mixin în documentația clasei

--incorpora-mixin [MODUL]
Încorporează metode mixin dintr-un anumit modul în documentația clasei

--fără evidențiere
Nu evidențiați blocurile de cod în ieșire.

--default-return TIP
Se afișează dacă metoda nu are un tip de returnare. (implicit la „Obiect”)

--ascunde-gol-întoarce
Ascunde tipurile de returnare specificate ca „void”. (este afișat implicit)

--interogare INTREBARE
Afișați numai obiectele care corespund unei anumite interogări

--titlu TITLUL
Adăugați un anumit titlu documentelor HTML

-r, --Citește-mă, --principal FILE
Fișierul readme folosit ca pagina de titlu a documentației.

--fișiere DOSAR1,DOSAR2, ...
Orice fișiere statice suplimentare separate prin virgulă care trebuie incluse (de exemplu, Întrebări frecvente)

--activ DIN[:LA]
Un fișier sau un director de copiat în directorul de ieșire după generare

-o, --output-dir PATH
Directorul de ieșire. (implicit la ./doc)

-m, --markup MARKUP
Stilul de marcare folosit în documentație, cum ar fi textil, markdown sau rdoc (implicit la rdoc).

-M MARKUP_PROVIDER
Ignoră biblioteca utilizată pentru a procesa marcajul

--markup-provider
formatare (specificați numele bijuteriei)

--charset ENC
Set de caractere de utilizat la analizarea fișierelor (implicit este localitatea sistemului)

-t, --șablon MODEL
Șablonul de utilizat. (implicit la „implicit”)

-p, --şablon-cale PATH
Calea șablonului în care se caută șabloane. (utilizată cu -t).

-f, --format FORMAT
Formatul de ieșire pentru șablon (implicit la html).

--fără-statistici
Nu tipăriți statistici

--locale LOCAL
Localitatea pentru documentația generată (implicit la en).

--po-dir DIR
Directorul care conține fișiere .po (implicit la #{YARD::Registry.po_dir}).

Etichetă opţiuni:
(TAG:TITLUL se pare ca: 'suprasarcină:Suprasolicitat Metodă')

--etichetă TAG:TITLUL
Înregistrează o nouă metadate în formă liberă @tag

--type-tag TAG:TITLUL
Etichetă cu un câmp opțional pentru tipuri

--type-name-tag TAG:TITLUL
Etichetă cu tipuri opționale și un câmp de nume

--nume-etichetă TAG:TITLUL
Etichetă cu un câmp de nume

--titlu-etichetă TAG:TITLUL
Etichetă cu prima linie ca câmp de titlu

--ascunde-etichetă TAG
Ascunde o etichetă definită anterior din șabloane

--etichetă-tranzitivă TAG
Marchează o etichetă ca tranzitivă

--etichetă-non-tranzitivă TAG
Marchează o etichetă ca netranzitivă

Altele opţiuni:
-e, --sarcină FILE
Un script Ruby de încărcat înainte de a rula comanda.

--conecteaza CONECTEAZA
Încărcați un plugin YARD (bijuterie cu prefixul „yard-”)

--moştenire
Folosiți parser și handlere Ruby în stil vechi. Întotdeauna activat în 1.8.x.

--sigur
Activați modul sigur pentru această instanță

-q, --Liniște
Nu afișați avertismente.

--verbos
Afișați mai multe informații.

--depanare
Afișați informațiile de depanare.

--backtrace
Afișați urmele stivei

-v, --versiune
Afișează versiunea.

-h, --Ajutor
Arată acest ajutor.

EXEMPLE

yardoc -o „documentație/” - „Întrebări frecvente” „LICENȚĂ”

Exemplul de mai sus scoate documentația pentru fișierele din „lib/**/*.rb” la „documentație/”
inclusiv fișierele suplimentare „FAQ” și „LICENSE”.

Utilizați yardoc online folosind serviciile onworks.net