PODWÓRKO (oprogramowanie)

DZIEDZINIEC
Oryginalni autorzy	Lorena Segala
Pierwsze wydanie	24 lutego 2007 ; 16 lat temu
Wersja stabilna	0.9.5 / 22 czerwca 2016 ; 6 lat temu
Magazyn	github.com/lsegal/yard _ _ _ ;
Napisane w	Rubin
System operacyjny	Międzyplatformowe
Typ	Wbudowany generator dokumentacji
Licencja	licencja MIT
Strona internetowa	stocznia.org _

YARD to wbudowany generator dokumentacji dla języka programowania Ruby . Analizuje kod źródłowy Ruby, generując ustrukturyzowaną kolekcję stron dla obiektów i metod Ruby. Komentarze do kodu można dodawać w naturalnym stylu.

YARD jest przydatny nawet wtedy, gdy docelowy kod źródłowy nie zawiera wyraźnych komentarzy. YARD nadal będzie analizować klasy, moduły i metody oraz wyświetlać je w wygenerowanych plikach API.

YARD rozszerza możliwości RDoc w wielu wymiarach:

rozciągliwość
modułowość
rozbiór gramatyczny zdania

Dan Kubb stworzył narzędzie pomocnicze o nazwie Yardstick, które weryfikuje zakres dokumentacji YARD (lub RDoc).

Zobacz też

Linki zewnętrzne