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

votos
36

Quiero formatear mis comentarios existentes como 'Comentarios RDOC' para que se puedan ver usando ri.

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

Publicado el 01/08/2008 a las 14:38
fuente por usuario
En otros idiomas...                            


2 respuestas

votos
14

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 --mainargumento de la línea de comandos.
  • igual que el anterior, pero para :title:
  • :section: no funciona muy bien
Respondida el 23/08/2008 a las 05:48
fuente por usuario

votos
9

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?

Respondida el 02/08/2008 a las 11:22
fuente por usuario

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