Szybka pomoc

Ściągawka z TomDoc

Skrócony przewodnik po standardzie dokumentacji kodu TomDoc dla języka Ruby: nagłówki metod, deklaracje argumentów i znaczniki widoczności.

· Opublikowano

TomDoc to specyfikacja dokumentacji służąca do tworzenia czytelnych, zrozumiałych dla człowieka komentarzy w kodzie.

Przykład nagłówka metody (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

Znaczniki widoczności (Visibility Tags)

  • Public: Dostępne dla zewnętrznych użytkowników biblioteki.
  • Internal: Używane wewnętrznie w modułach biblioteki; nie stanowi części publicznego API.
  • Deprecated: Przeznaczone do usunięcia w przyszłych wersjach.

Argumenty i opcje (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).

Instrukcje 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.

Sygnatury metod (Method Signatures)

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

Źródła

Powiązane tematy