РДок

РДок
Оригинальный автор(ы)	Дэйв Томас
Стабильная версия	5.1.0 / 24 февраля 2017 г .; 7 лет назад
Репозиторий	github .с /рубин /рдок ;
Написано в	Руби
Операционная система	Кросс-платформенный
Тип	встроенный генератор документации
Лицензия	лицензия GPLv2
Веб-сайт	рубин .github .что /рдок /

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 специальные директивы заключаются в пару двоеточий. Например, чтобы указать, что метод принимает аргументы, называемые site и article, можно написать :args: site, article. ^{[ 1 ]}