Référence rapide

Aide-mémoire TomDoc

Guide de référence rapide pour le standard de documentation TomDoc en Ruby : en-têtes de méthodes, arguments et tags de visibilité.

· Publié le

TomDoc est une spécification de documentation permettant de rédiger des commentaires de code clairs et lisibles par les humains.

Exemple d'en-tête de méthode (Method Header)

# Public: Duplicate some text an arbitrary number of times.
#
# text  - The String to be duplicated.
# count - The Integer number of times to duplicate the text.
#
# Examples
#
#   multiplex('Tom', 4)
#   # => 'TomTomTomTom'
#
# Returns the duplicated String.
def multiplex(text, count)
  text * count
end

Balises de visibilité (Visibility Tags)

  • Public : Accessible aux utilisateurs externes de la bibliothèque.
  • Internal : Utilisé en interne dans les modules ; ne fait pas partie de l'API publique.
  • Deprecated : Prévu pour être supprimé dans les versions futures.

Arguments et options (Arguments and Options)

# options - The Hash options used to refine selection (default: {}):
#           :color  - The String color to restrict by (optional).
#           :weight - The Float weight in grams (optional).

Instructions Yields et Return

# Yields the Integer index of the current iteration.
#
# Returns the duplicated String.
# Returns nothing.
# Raises Errno::ENOENT if the file cannot be located.

Signatures de méthodes (Method Signatures)

# Signature
#
#   find_by_<field>[_and_<field>...](args)

Références

Sujets associés