Comment puis-je ajouter des commentaires existants à RDoc en Ruby?

voix
36

Je veux formater mes commentaires existants « commentaires rdoc » afin qu'ils puissent être consultés à l' aide ri.

Quelles sont les ressources recommandées pour le démarrage à l'aide RDoc?

Créé 01/08/2008 à 14:38
source utilisateur
Dans d'autres langues...                            


2 réponses

voix
14

Quelques choses qui me mordent:

  • :main:- RDoc utilise uniquement la dernière évaluation; mieux pour vous assurer qu'il n'y a qu'un seul dans votre projet et vous ne pas utiliser aussi l' --mainargument de ligne de commande.
  • Identique au précédent, mais pour :title:
  • :section: ne fonctionne pas très bien
Créé 23/08/2008 à 05:48
source utilisateur

voix
9

RDoc utilise SimpleMarkup donc il est assez simple de créer des listes, etc., en utilisant *, - ou un numéro. Il traite également des lignes qui sont en retrait au même numéro de colonne dans le cadre du même paragraphe jusqu'à ce qu'il y est une ligne vide qui signifie un nouveau paragraphe. Avez-vous quelques exemples de commentaires que vous voulez RDoc'ed afin que nous puissions vous montrer comment les faire et vous pouvez extrapoler que pour le reste de vos commentaires?

Créé 02/08/2008 à 11:22
source utilisateur

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