请输入您要查询的百科知识:

 

词条 RDoc
释义

  1. See also

  2. External links

{{for|the medical framework|Research Domain Criteria}}{{unreferenced|date=August 2018}}{{Infobox Software
| name = RDoc
| screenshot =
| caption =
| author = Dave Thomas
| developer =
| released =
| latest release version = 5.1.0
| latest release date = {{Start date and age|2017|02|24}}
| latest preview version =
| latest preview date =
| operating system = Cross-platform
| platform =
| programming language = Ruby
| genre = embedded documentation generator
| license = GPLv2
| website = {{URL|https://ruby.github.io/rdoc/}}
}}

RDoc, designed by Dave Thomas, is an embedded documentation generator for the Ruby programming language.

It analyzes 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. The RDoc software and format are successors to the Ruby Document format (with associated software RD).

RDoc can produce usable documentation even if the target source code does not contain explicit comments as it 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, providing access to API information from the command line.

RDoc and ri are currently maintained by Eric Hodel and Ryan Davis.

See also

{{Portal|Free and open-source software}}
  • Comparison of documentation generators

External links

  • Chapter on RubyDoc in the Ruby Wikibook
{{Ruby programming language}}{{Compu-soft-stub}}

1 : Free documentation generators

随便看

 

开放百科全书收录14589846条英语、德语、日语等多语种百科知识,基本涵盖了大多数领域的百科知识,是一部内容自由、开放的电子版国际百科全书。

 

Copyright © 2023 OENC.NET All Rights Reserved
京ICP备2021023879号 更新时间:2024/9/20 13:38:25