YARD (software)
≈ 2 min read
Names in other languages
No names in other languages are held for this entry yet.
Article bodies are English and are not machine-translated. A name in another language is not a translation of the article.
YARD (Yay! A Ruby Documentation Tool ) 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.
YARD (Yay! A Ruby Documentation Tool ) 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. ==References==
Text derived from https://en.wikipedia.org/w/index.php?oldid=1366170603 under CC BY-SA 4.0; modifications have been made.