19.2. Automatyczne generowanie dokumentacji

Podziękowania dla Stefana Langa

Problem

Chcemy automatycznie utworzyć strony HTML na podstawie komentarzy sformatowanych zgodnie ze standardem RDoc w kodzie oraz innych plikach zwierających takie komentarze.

Rozwiązanie

W pliku Rakefile należy użyć instrukcji require rake/rdoctask i utworzyć nowy egzemplarz klasy Rake::RDocTask. Oto typowy przykład:

require 'rake/rdoctask'

Rake::RDocTask.new('rdoc') do |t|
  t.rdoc_files.include('README', 'lib/**/*.rb')
  t.main = 'README'
  t.title = "Dokumentacja interfejsu API biblioteki MojaBiblioteka"
end

Można teraz uruchomić polecenie rake rdoc z wiersza polecenia w głównym katalogu projektu. Powyższe zadanie tworzy dokumentację interfejsu API wszystkich ...

Get Ruby. Receptury now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.

Start your free trial