utilisation - Comment ajouter des commentaires existants à RDoc dans Ruby?




syntaxe ruby (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 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?

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

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


Quelques petites choses qui m'ont mordu:

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




rdoc