Какво трябва да използвам, за да документирам своите маршрути на Синатра?

Търся нещо като RDoc, което ще работи добре със Sinatra. В допълнение към обикновените маршрути на Sinatra, той трябва да може да обработва маршрути, които се зареждат външно чрез „register MyModule“ и във формата:

Module MyModule
  def self.registered(app)
    # Description of someroute.
    app.get '/someroute' do

ruby sinatra
person Stephen Petschulat    schedule 13.12.2010    source източник
comment
Какъв вид документация се опитвате да създадете? Какви аспекти на вашето приложение искате да документирате? Само маршрутите? Параметрите, които маршрутът приема? Защо коментарите във вашия изходен код не са достатъчни?   -  person Phrogz    schedule 18.12.2010
comment
По принцип същият случай на употреба като RDoc. Бих искал името, описанието и параметрите да се показват -- примерното използване би било бонус. В момента коментарите са в изходния код, но бих искал автоматично да генерирам отделна документация за HTML програмист.   -  person Stephen Petschulat    schedule 19.12.2010

Отговори (2)


arrow_upward
3
arrow_downward

Отидете с yard. от началната страница на yard:

Можете да пишете всякакви разширения в YARD, включително такива, които могат да разберат цялата динамична магия, която вашата рамка прави в собствените си малки Doman Specific Languages ​​(DSL). Най-важното е, че е наистина лесно да се направи! Вече има добавки, които поддържат рамки като RSpec, DataMapper, Sinatra, а поддръжката за други се работи.

Изглежда има плъгин тук: https://github.com/rkh/yard-sinatra това прави поне част от това, което вече искате.

Късмет!

person gunn    schedule 20.12.2010

arrow_upward
2
arrow_downward

Просто исках да отбележа, че Yard поддържа маршрути на Sinatra първоначално от v0.7.0, така че вече нямате нужда от yard-sinatra.

Можете да намерите повече информация на https://github.com/lsegal/yard/wiki/SinatraRoutes

person nbarraille    schedule 17.04.2013
comment
За съжаление не открих, че това е така. Трябваше да gem install yard yard-sinatra (в момента съответно 0.9.16 и 1.0.0) и да извикам с yard --plugin yard-sinatra - person Jeff Ward; 10.10.2018