Referință rapidă

Fişă de noțiuni TomDoc

Ghid de referință rapidă pentru standardul de documentare TomDoc în Ruby: antete de metode, declararea argumentelor și etichete de vizibilitate.

· Publicat

TomDoc este o specificație de documentare pentru redactarea de comentarii de cod clare și ușor de citit.

Exemplu de antet de metodă (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

Etichete de vizibilitate (Visibility Tags)

  • Public: Disponibil pentru utilizatorii externi ai bibliotecii.
  • Internal: Utilizat intern între module; nu face parte din API-ul public.
  • Deprecated: Programat pentru eliminare în versiunile viitoare.

Argumente și opțiuni (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).

Instrucțiuni Yields și Return

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

Semnături de metode (Method Signatures)

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

Referințe

Subiecte conexe