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

Question

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

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

Answer 1

RDoc usa SimpleMarkup así que es bastante simple crear listas, etc. usando *, - o un número. También trata las líneas que tienen 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 desee con RDoc para poder mostrarle cómo hacerlos y luego podría extrapolarlos para el resto de sus comentarios?

Answer 2

Algunas cosas que me han picado:

• :main: - RDoc usa solo el último evaluado; Lo mejor es asegurarse de que solo haya uno en su proyecto y que no use el argumento de la línea de comandos --main .
• igual que el anterior, pero para :title:
• :section: no funciona muy bien