YARD

YARDOriginal author(s)| Loren Segal

|

Initial release| February 24, 2007; 19 years ago (2007-02-24)
Stable release|

0.9.5 / June 22, 2016; 9 years ago (2016-06-22)[1]

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

* Comparison of documentation generators
* RDoc
* Ruby Document format

## References

1. ↑ Yard - RubiGems.org

## External links

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

* v
* t
* e

Ruby programming language

Implementations|

| Active|

* Ruby MRI; YARV
* mruby
* JRuby
* Rubinius
* MagLev
* RubyMotion

|

Discontinued|

* MacRuby
* IronRuby
* XRuby
* HotRuby

IDE|

* Komodo
* NetBeans
* RadRails
* RubyMine

Applications|

* Capistrano
* Hackety Hack
* Interactive Ruby Shell
* Pry
* Rake
* Redmine
* RSpec
* RubyGems
* RVM
* Chef
* Puppet
* Vagrant
* Homebrew
* CocoaPods
* fastlane (mobile app build automation tools)

Libraries and frameworks|

* Adhearsion
* Camping
* eRuby (RHTML)
* 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|

* Document format
* why's (poignant) Guide to Ruby
* Ruby Central
* RubyKaigi
* RubyForge
* Ruby License

* Category
* Commons

0.00

(0 votes)

|

Retrieved from "https://handwiki.org/wiki/index.php?title=Software:YARD&oldid=764025"
*[v]: View this template
*[t]: Discuss this template
*[e]: Edit this template