Comment ajouter des commentaires existants à RDoc dans Ruby?

Je veux mettre en forme mes commentaires existants en tant que 'commentaires RDoc' afin qu'ils puissent être visualisés en utilisant ri .

Quelles sont les ressources recommandées pour commencer à utiliser RDoc?

0
ajouté édité
Vues: 16
Jetez un coup d'oeil sur le Docs
ajouté l'auteur Tobias, source

2 Réponses

Quelques petites choses qui m'ont mordu:

  • :main: -- RDoc uses only the last one evaluated; best to make sure there's only one in your project and you don't also use the --main command-line argument.
  • same as previous, but for :title:
  • :section: doesn't work very well
0
ajouté

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

0
ajouté