Documenter vos sources

1. Format

a. Usage simple

En utilisant un certain format dans vos commentaires, vous pouvez générer une documentation de vos sources. Cette documentation rend votre travail plus lisible. Par défaut seules les méthodes publiques sont exploitées.

Nous allons créer deux fichiers sources dans un répertoire commun.

maClasse.rb:
# Ma classe

class MaClasse
  # Ma methode
  def maMethode()
  end
end 
autreClasse.rb:
# Une autre classe

class AutreClasse
  # Une autre methode
  def autreMethode()
  end
end 

Avec votre shell favori, positionnez-vous dans ce répertoire et utilisez la commande rdoc (présente dans le répertoire bin de votre installation ruby). Sous Windows, il vous suffit d’ouvrir une console en exécutant cmd.exe et d’utiliser la commande cd pour se déplacer dans un répertoire.

CH5-1.png

À l’issue de cette commande, un répertoire doc est créé contenant les pages HTML générées, la page principale étant index.html. Si vous ouvrez cette page, vous naviguerez dans vos deux fichiers sources.

Le commentaire de la classe et de la méthode a bien été pris en compte.

CH5-2.png
Si vous avez des accents dans vos commentaires, il vous faut connaître l’encoding (ou charset) employé par votre navigateur lors de la sauvegarde, cela peut être iso-8859-1 ou bien utf8. Grâce à l’option -c et en précisant cet encoding, les pages générées conserveront...
Pour consulter la suite, découvrez le livre suivant :
couv_Ruby.PNG
60-signet.svg
En version papier
20-ecran_lettre.svg
En version numérique
41-logo_abonnement.svg
En illimité avec l'abonnement ENI
130-boutique.svg
Sur la boutique officielle ENI
Précédent
Exercices
Suivant
Les entrées/sorties