2009-06-29 16 views
14

Pytanie: Jak mogę dokumentować kod Ruby za pomocą Doxygen?Jak dokumentować kod Ruby za pomocą Doxygen?

Nota prawna: Wiem, że ruby ​​ma już wbudowany system dokumentacji i prawdopodobnie istnieją inne sposoby, aby to zrobić, ale specyficznym ograniczeniem, które stosuję, jest to, jak zrobić Doxygen do wykonania zadania (zakładając, że jest możliwy).

Odpowiedz

18

Krótka odpowiedź, nie. Długa odpowiedź, wciąż nie. Doxygen w końcu dotrze do Ruby, ale nie mam poczucia, że ​​to się wydarzy w najbliższym czasie. Na krótką metę utkniesz z RDoc lub YARD.

+0

Przyjemna odpowiedź bez udziwnień. +1 – dreftymac

+1

YARD jest niesamowity, pójdę z tym :) –

+0

Jakieś uaktualnienie do tej odpowiedzi, prawie 8 lat później? – Magne

2

Możesz wypróbować wersję testową pod numerem https://github.com/fourmond/doxygen-ruby-patch. Nadal jest to eksperymentalne, ale poprzez testowanie, miejmy nadzieję, zostanie włączone do głównego nurtu doxygen.

+0

"Fourmond autorstwa 3 lata temu", myślę, że to nigdy nie wróciło w górę? – JeanMertz

Powiązane problemy