Jak přidám existující komentáře RDoc v Ruby?

hlasů
36

Chci formátovat existující komentáře jako ‚RDoc komentáře‘, takže je lze zobrazit pomocí ri.

Jaké jsou některé doporučené zdroje pro začínající pomocí RDoc?

Položena 01/08/2008 v 14:38
zdroj uživatelem
V jiných jazycích...                            


2 odpovědí

hlasů
14

Pár věcí, které se mi Zakousnutá:

  • :main:- RDoc používá pouze ten poslední vyhodnoceny; nejlepší, aby se ujistil, že je jen jeden v projektu a nechcete použít také --mainargument příkazového řádku.
  • stejné jako předchozí, ale pro :title:
  • :section: nefunguje dobře
Odpovězeno 23/08/2008 v 05:48
zdroj uživatelem

hlasů
9

RDoc používá SimpleMarkup, takže je to docela jednoduché vytvořit seznamy, atd. Pomocí *, - nebo číslo. To také léčí linie, které jsou odsazeny ve stejné číslo sloupce jako součást téhož odstavce, dokud není prázdný řádek což znamená nový odstavec. Máte několik příkladů komentářů chcete RDoc'ed takže jsme mohli ukázat, jak to udělat je a pak můžete odvodit, že pro zbytek svých komentářích?

Odpovězeno 02/08/2008 v 11:22
zdroj uživatelem

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