Quiero formatear mis comentarios existentes como 'comentarios RDoc' para que puedan verse usando ri.¿Cómo agrego los comentarios existentes a RDoc en Ruby?
¿Cuáles son algunos recursos recomendados para comenzar a usar RDoc?
RDoc usa SimpleMarkup por lo 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?
Un par de cosas que me han picado:
:main: - RDoc utiliza sólo la última evaluado; Lo mejor es asegurarse de que solo haya uno en su proyecto y que no use el argumento de línea de comandos --main.:title::section: no funciona muy bien
Toma una vista de los [Docs] (http://docs.seattlerb.org/rdoc/) – Tobias