Como faço para adicionar comentários existentes para RDoc em Ruby?[fechado]

Question

Eu quero formatar meu existente comentários como 'RDoc comentários" então, eles podem ser visualizados usando ri.

Quais são alguns dos recursos recomendados para começar a utilizar RDoc?

Answer 1

Algumas coisas que têm me mordido:

• :main: -- RDoc usa apenas a última avaliação;melhor certificar-se que só há um no seu projeto e você não utilizar também o --main argumento de linha de comando.
• mesmo que a anterior, mas para :title:
• :section: não funciona muito bem

Answer 2

RDoc usa SimpleMarkup por isso é bastante simples de criar listas, etc.usando *, - ou um número.Ele também trata de linhas que são recuadas no mesmo número da coluna como parte do mesmo parágrafo, até que haja uma linha em branco, o que significa um novo parágrafo.Você tem alguns exemplos de comentários que você deseja RDoc ed) assim, podemos mostrar-lhe como fazê-las e, em seguida, você pode extrapolar isso para o resto de seus comentários?