RDoc - RDoc

tento článek potřebuje další citace pro ověření. Prosím pomozte vylepšit tento článek podle přidávání citací ke spolehlivým zdrojům. Zdroj bez zdroje může být napaden a odstraněn. Najít zdroje: "RDoc"  – zprávy  · noviny  · knihy  · učenec  · JSTOR (Srpna 2018) (Zjistěte, jak a kdy odstranit tuto zprávu šablony)

RDoc

Původní autoři	Dave Thomas
Stabilní uvolnění	5.1.0 / 24. února 2017; před 3 lety (2017-02-24)
Úložiště	github.com/rubín/ rdoc
Napsáno	Rubín
Operační systém	Cross-platform
Typ	vestavěný generátor dokumentace
Licence	GPLv2
webová stránka	rubín.github.io/ rdoc/

RDoc, navrhl Dave Thomas, je vestavěný generátor dokumentace pro Programovací jazyk Ruby Analyzuje Ruby zdrojový kód, generující strukturovanou kolekci stránek pro Ruby předměty a metody.Kód komentáře lze přidat v přirozeném stylu. RDoc je zahrnut jako součást distribuce jádra Ruby. Software a formát RDoc jsou nástupci Ruby formát dokumentu (s přidruženým softwarem RD).

RDoc může vytvořit použitelnou dokumentaci, i když cílový zdrojový kód neobsahuje explicitní komentáře, protože bude stále analyzovat the třídy, moduly a metody a uveďte je ve vygenerovaných API soubory. RDoc také poskytuje motor pro vytváření datových souborů Ruby ri a poskytuje přístup k informacím API z příkazový řádek.

RDoc a ri v současné době udržuje Eric Hodel a Ryan Davis.

Syntax

RDoc podporuje čtyři značkovací jazyky, RDoc Markup, Snížení, tomdoc a rdtool. Ve výchozím nastavení se používá jeho vlastní označení RDoc. V RDoc Markup jsou speciální směrnice uzavřeny v dvojtečce. Například k označení, že metoda bere volané argumenty stránky a článek, lze psát : args: site, článek.^[1]

Viz také

• Porovnání generátorů dokumentace

Reference

externí odkazy

• Kapitola o RubyDoc ve Wikibooku Ruby

Tento software článek je a pahýl. Wikipedii můžete pomoci pomocí rozšiřovat to.