Riferimento rapido

Scheda di riferimento TomDoc

Guida rapida allo standard di documentazione del codice TomDoc per Ruby: intestazioni dei metodi, dichiarazioni degli argomenti e tag.

· Pubblicato

TomDoc è una specifica di documentazione per scrivere commenti di codice chiari e leggibili dalle persone.

Esempio di intestazione del metodo (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

Tag di visibilità (Visibility Tags)

  • Public: Disponibile per l'utilizzo da parte degli utenti esterni della libreria.
  • Internal: Utilizzato internamente tra i moduli; non fa parte dell'API pubblica.
  • Deprecated: Previsto per la rimozione nelle versioni future.

Argomenti e opzioni (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).

Istruzioni Yields e Return

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

Firme dei metodi (Method Signatures)

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

Riferimenti

Argomenti correlati