RDoc

Эта статья требует дополнительных ссылок для проверки . Пожалуйста, помогите улучшить эту статью , добавив цитаты из надежных источников . Материал, не полученный от источника, может быть оспорен и удален. Поиск источников:  «RDoc»  -  новости  · газеты  · книги  · ученый  · JSTOR ( август 2018 г. ) ( Узнайте, как и когда удалить это сообщение-шаблон )

RDoc , разработанный Дэйвом Томасом , представляет собой встроенный генератор документации для языка программирования Ruby . Он анализирует исходный код Ruby , генерируя структурированный набор страниц для объектов и методов Ruby . Комментарии к коду можно добавлять в естественном стиле. RDoc входит в состав ядра Ruby. Программное обеспечение и формат RDoc являются преемниками формата Ruby Document (с соответствующим программным обеспечением RD).

RDoc может производить полезную документацию , даже если целевые исходный код не содержит явные комментарии, он все равно будет разобрать на классы , модули и методы, и список их в сгенерированных API файлов. RDoc также предоставляет движок для создания файлов данных Ruby ri, обеспечивая доступ к информации API из командной строки .

RDoc и ri в настоящее время поддерживаются Эриком Ходелом и Райаном Дэвисом .

Синтаксис

RDoc поддерживает четыре языка разметки: RDoc Markup, Markdown , tomdoc и rdtool. По умолчанию используется собственная разметка RDoc. В RDoc Markup специальные директивы заключаются в пару двоеточий. Например, чтобы указать, что метод принимает аргументы, вызываемые siteи article, можно написать :args: site, article. ^[1]

Смотрите также

• Сравнение генераторов документации

использованная литература

внешние ссылки

• Глава о RubyDoc в Ruby Wikibook

Эта статья о программном обеспечении - незавершенная . Вы можете помочь Википедии, расширив ее .

• v
• т
• е