NRuby

1
Вместо rdoc в проектах часто используется более богатый возможностями гем yard,
2
установить который можно при помощи утилиты gem (см. разд. 3.6).
3
Листинг 3.8. Комментарии для извлечения утилитой rdoc. Файл rdoc.rb
4
##
5
# Класс для вывода приветствия
6
class Hello54
7
Глава 3
8
##
9
# Выводит в стандартный вывод строку приветствия,
10
# интерполируя в нее параметр +row_count+
11
#
12
# = Пример использования
13
#
14
#
15
h = Hello.new
16
#
17
h.geeting('Ruby')
18
def greeting(name)
19
puts "Hello, #{name}"
20
end
21
end
22
Для того чтобы извлечь документацию из файла rdoc.rb, достаточно передать его
23
утилите rdoc:
24
$ rdoc rdoc.rb
25
В ответ будет сформирована папка doc, содержащая всю извлеченную документа-
26
цию в HTML-формате. Для навигации по документации следует запустить индекс-
27
ный файл index.html в браузере.