Documenting with YARD
YARD (http://yardoc.org) is an extension of RDoc that uses tags to allow you to add metadata to your comments. It then uses the metadata to create more interesting documentation.
|
Yet Another Aside | |
|---|---|
|
While YARD claims to be short for “Yay! A Ruby Documentation Tool,” it likely was named in reference to the long-standing open-source tradition of starting acronyms with YA for “yet another.” We think the first tool to this was the Yacc parser-generator (for "Yet Another Compiler Compiler"), but there’s also YAML (originally "Yet Another Markup Language," now styled as "YAML Ain’t Markup Language," which is a whole other open-source ... |
Get Programming Ruby 3.3 now with the O’Reilly learning platform.
O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.
