YARD (software)

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

• Comparison of documentation generators
• RDoc
• Ruby Document format

External links

• YARD project home page
• Loren Segal's YARD page on GitHub
• Dan Kubb's Yardstick page on GitHub

Ruby programming language Implementations Active Ruby MRI / YARV mruby JRuby Rubinius MagLev RubyMotion Discontinued MacRuby IronRuby XRuby RubyJS HotRuby IDE Komodo NetBeans RadRails RubyMine Applications Capistrano Chef Hackety Hack Homebrew Interactive Ruby Shell Pry Puppet Rake Redmine RSpec RubyGems RVM Libraries and frameworks Adhearsion Camping eRuby (RHTML) Gosu Merb Padrino RubyCocoa Ruby on Rails Shoes Sinatra QtRuby Server software mod_ruby Mongrel Phusion Passenger (mod_rails/mod_rack) Rack WEBrick People Yukihiro Matsumoto David Heinemeier Hansson why the lucky stiff Other Application Archives Document format why's (poignant) Guide to Ruby Ruby Central RubyKaigi RubyForge Ruby License Category Commons