YARD (software)

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Original author(s) Loren Segal
Initial release February 24, 2007; 10 years ago (2007-02-24)
Stable release
0.9.5 / June 22, 2016; 17 months ago (2016-06-22)[1]
Repository github.com/lsegal/yard
Written in Ruby
Operating system Cross-platform
Type Embedded documentation generator
License MIT license
Website yardoc.org

YARD, is an embedded documentation generator for the Ruby programming language. It analyzes the Ruby source code, generating a structured collection of pages for Ruby objects and methods. Code comments can be added in a natural style.

YARD is useful even if the target source code does not contain explicit comments. YARD will still parse the classes, modules, and methods, and list them in the generated API files.

YARD extends upon the capabilities of RDoc in a number of dimensions:

  • extensibility
  • modularity
  • parsing

Dan Kubb has created an ancillary tool, named Yardstick, which verifies YARD (or RDoc) documentation coverage.

See also[edit]


External links[edit]