¿Cómo agrego comentarios existentes a RDoc en Ruby?[cerrado]

Question

Quiero formatear mis comentarios existentes como 'comentarios RDoc' para que puedan verse usando ri.

¿Cuáles son algunos recursos recomendados para comenzar a utilizar RDoc?

Answer 1

Algunas cosas que me han picado:

• :main: -- RDoc utiliza sólo el último evaluado;Lo mejor es asegurarse de que solo haya uno en su proyecto y no utilizar también el --main argumento de línea de comando.
• igual que el anterior, pero por :title:
• :section: no funciona muy bien

Answer 2

RDoc usa SimpleMarkup por lo que es bastante sencillo crear listas, etc.usando *, - o un número.También trata las líneas con sangría en el mismo número de columna como parte del mismo párrafo hasta que haya una línea vacía que indique un nuevo párrafo.¿Tiene algunos ejemplos de comentarios que desea RDoc'ed para que podamos mostrarle cómo hacerlos y luego pueda extrapolarlos para el resto de sus comentarios?