Comment ajouter des commentaires existants à RDoc dans Ruby?

Translate

Je souhaite mettre en forme mes commentaires existants en tant que `` commentaires RDoc '' afin qu'ils puissent être affichés en utilisantri.

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

This question and all comments follow the "Attribution Required."

Toutes les réponses

Translate

Quelques petites choses qui m'ont mordu:

  • :main:- RDoc n'utilise que le dernier évalué; mieux vaut vous assurer qu'il n'y en a qu'un dans votre projet et que vous n'utilisez pas également le--mainargument de ligne de commande.
  • identique à la précédente, mais pour:title:
  • :section:ne fonctionne pas très bien
La source
Translate

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 indentées au même numéro de colonne dans le cadre 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 souhaitez recopier pour que nous puissions vous montrer comment les faire et vous pourrez ensuite les extrapoler pour le reste de vos commentaires?

La source