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

votos
36

Eu quero formatar meus comentários existentes como 'comentários RDoc' para que eles possam ser vistos usando ri.

Quais são alguns recursos recomendados para começar usando RDoc?

Publicado 01/08/2008 em 14:38
fonte usuário
Em outras línguas...                            


2 respostas

votos
14

Algumas coisas que têm me mordido:

  • :main:- RDoc usa apenas o último avaliado; melhor para se certificar de que há apenas um em seu projeto e você também não usar o --mainargumento de linha de comando.
  • mesmo que anterior, mas para :title:
  • :section: não funciona muito bem
Respondeu 23/08/2008 em 05:48
fonte usuário

votos
9

RDoc usa SimpleMarkup por isso é bastante simples de criar listas, etc. usando *, - ou um número. É também trata linhas que são recuados no mesmo número de coluna como parte do mesmo número até que não é uma linha de vazio que significa um novo ponto. Você tem alguns exemplos de comentários que você quer RDoc'ed para que pudéssemos mostrar-lhe como fazê-las e, em seguida, você pode extrapolar isso para o resto de seus comentários?

Respondeu 02/08/2008 em 11:22
fonte usuário

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