Chcę sformatować moje istniejące komentarze jako "komentarze RDoc", aby można było je wyświetlić za pomocą ri.Jak dodać istniejące komentarze do RDoc w Ruby?
Jakie są zalecane zasoby do rozpoczęcia korzystania z RDoc?
RDoc używa SimpleMarkup, więc tworzenie list itp. Jest dość proste przy użyciu *, - lub liczby. Traktuje również wiersze, które są wcięte na tym samym numerze kolumny jako część tego samego akapitu, dopóki nie pojawi się pusty wiersz, który oznacza nowy akapit. Czy masz kilka przykładów komentarzy, które chcesz poddać RDoc, abyśmy mogli pokazać Ci, jak je wykonać, a następnie możesz je ekstrapolować w odniesieniu do pozostałych komentarzy?
Kilka rzeczy, które gryzie mnie:
:main: - rdoc używa tylko ostatni oceniany; najlepiej, aby upewnić się, że jest tylko jeden w twoim projekcie i nie używasz również argumentu wiersza poleceń w postaci --main.:title::section: nie działa bardzo dobrze
Spójrz do [DOCS] (http://docs.seattlerb.org/rdoc/) – Tobias