Jak dodać istniejących komentarzy do rdoc w Ruby?

głosy
36

Chcę sformatować moje dotychczasowe komentarze jako „Uwagi rdoc”, więc mogą być przeglądane za pomocą ri.

Jakie są zalecane środki na rozpoczynający się za pomocą rdoc?

Utwórz 01/08/2008 o 14:38
źródło użytkownik
W innych językach...                            


2 odpowiedzi

głosy
14

Kilka rzeczy, które gryzie mnie:

  • :main:- rdoc używa tylko ostatni oceniany; najlepiej, aby upewnić się, że jest tylko jeden w projekcie, a nie również użyć --mainargumentu wiersza poleceń.
  • taki sam jak poprzedni, ale dla :title:
  • :section: nie działa bardzo dobrze
Odpowiedział 23/08/2008 o 05:48
źródło użytkownik

głosy
9

Rdoc wykorzystuje SimpleMarkup więc jest to dość proste do tworzenia list itp korzystania * - lub numer. Traktuje to również linie są wcięte pod tym samym numerem kolumny w ramach tego samego paragrafu, dopóki nie jest pusta linia co oznacza nowy akapit. Czy masz kilka przykładów komentarzy chcesz RDoc'ed więc możemy wam pokazać, jak je zrobić, a następnie można ekstrapolować, że do końca swoich komentarzach?

Odpowiedział 02/08/2008 o 11:22
źródło użytkownik

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more