YARD (software)
| Original author(s) | Loren Segal |
|---|---|
| Initial release | February 24, 2007 |
| Stable release | 0.7.5 / January 31, 2012 |
| Written in | Ruby |
| Operating system | Cross-platform |
| Type | Embedded documentation generator |
| License | MIT license |
| Website |
yardoc |
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
External links
| |||||||||||||||||||||||||||||||||||||||||||
This article is issued from Wikipedia - version of the Friday, October 11, 2013. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.