Bagaimana cara menambahkan ada komentar untuk RDoc di Ruby?

Saya ingin memformat komentar yang ada sebagai 'RDoc komentar' sehingga mereka dapat dilihat dengan menggunakan ri.

Apa adalah beberapa sumber daya yang dianjurkan untuk memulai menggunakan RDoc?

Mengomentari pertanyaan (1)

Beberapa hal yang telah digigit saya:

  • :main: -- RDoc menggunakan hanya yang terakhir dievaluasi; terbaik untuk memastikan ada's hanya satu dalam proyek anda dan anda don't juga menggunakan --main argumen baris perintah.
  • sama seperti sebelumnya, tapi untuk :judul:
  • :bagian: doesn't bekerja dengan sangat baik
Komentar (0)

RDoc menggunakan SimpleMarkup jadi's cukup sederhana untuk membuat daftar, dll. menggunakan *, - atau jumlah. Hal ini juga memperlakukan garis yang menjorok pada kolom yang sama angka sebagai bagian dari ayat yang sama sampai ada baris kosong yang menandakan paragraf baru. Apakah anda memiliki beberapa contoh komentar yang anda inginkan RDoc'ed jadi kita bisa menunjukkan kepada anda bagaimana untuk melakukannya, dan kemudian anda bisa meramalkan bahwa untuk sisa dari komentar anda?

Komentar (0)