RDoc

RDoc

Infobox Software
name = RDoc


caption =
author = Dave Thomas
developer =
released =
latest release version =
latest release date =
latest preview version =
latest preview date =
operating system = Cross-platform
platform =
programming language = Ruby
genre = embedded documentation generator
license =
website = [http://www.ruby-doc.org/core/classes/RDoc.html RDoc documentation]

RDoc, designed by Dave Thomas, is the embedded documentation generatorfor 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.RDoc is included as part of the Ruby core distribution.

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

RDoc also provides the engine for creating Ruby ri data files. ri is (more or less) Ruby's version of man pages, serving up API information from the command line.

RDoc and ri are currently maintained by Eric Hodel and Ryan Davis. Bug reports and patches may be submitted via [http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse RubyForge.org]

See also

* Comparison of documentation generators

External links

*
* [http://rdoc.rubyforge.org/rdoc/ RDoc documentation]
* [http://weblog.jamisbuck.org/2005/4/8/rdoc-template Ruby on Rails - Template]


Wikimedia Foundation. 2010.

Игры ⚽ Поможем написать курсовую

Look at other dictionaries:

  • RDoc — (pour Ruby Documentation) est le générateur de documentation embarqué pour le langage Ruby, développé par Dave Thomas. En analysant du code source Ruby, il permet de générer une collection de pages (au format HTML par exemple) pour les objets et… …   Wikipédia en Français

  • RDOC — Integrated Surgical Systems, Inc. (Business » NASDAQ Symbols) …   Abbreviations dictionary

  • RDOC — Reference Disgnation Overflow Code NASA …   Acronyms

  • RDOC — Reference Disgnation Overflow Code ( > NASA Acronym List ) …   Acronyms von A bis Z

  • RDOC — abbr. INTEGRATED SURGICAL SYS NASDAQ …   Dictionary of abbreviations

  • Comparison of documentation generators — The following tables compare general and technical information for a number of documentation generators. Please see the individual products articles for further information. This article is not all inclusive or necessarily up to date. Unless… …   Wikipedia

  • Anexo:Comparativa de generadores de documentación — Las siguientes tablas comparan información general y técnica de un número de generadores de documentación. Por favor, consulte la página individual de cada producto para obtener información adicional. Este artículo no incluye todos los… …   Wikipedia Español

  • Ruby (Programmiersprache) — Ruby Offizielles Logo Basisdaten Paradigmen: multiparadigmatisch Erscheinungsjahr: 1995 …   Deutsch Wikipedia

  • Ruby Document format — RD is a lightweight markup language for writing Ruby related documents. It can be embeded in Ruby source code.RD is an abbreviation for Ruby Document.RD is a traditional format. In modern, Ruby developers tend to write documents in RDoc instead… …   Wikipedia

  • National Institute of Mental Health — Agency overview Formed April 14, 1949 Headquarters Bethesda, Maryland, U.S …   Wikipedia

Share the article and excerpts

Direct link
… Do a right-click on the link above
and select “Copy Link”