Comment ajouter des commentaires existants à RDoc dans Ruby ?[fermé]

Question

Je souhaite formater mes commentaires existants en tant que « commentaires RDoc » afin qu'ils puissent être consultés à l'aide de ri.

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

Answer 1

Quelques choses qui m'ont mordu:

• :main: -- RDoc utilise uniquement le dernier évalué ;mieux vaut s'assurer qu'il n'y en a qu'un dans votre projet et que vous n'utilisez pas également le --main argument de ligne de commande.
• comme le précédent, mais pour :title:
• :section: ça ne marche pas très bien

Answer 2

RDoc utilise SimpleMarkup, il est donc assez simple de créer des listes, etc.en utilisant *, - ou un nombre.Il traite également les lignes qui sont en retrait au même numéro de colonne comme faisant partie du 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 souhaiteriez faire étudier afin que nous puissions vous montrer comment les faire et que vous puissiez ensuite extrapoler cela pour le reste de vos commentaires ?