Краткий справочник

Шпаргалка по TomDoc

Краткое справочное руководство по стандарту документирования кода TomDoc для Ruby: заголовки методов, аргументы и теги видимости.

· Опубликовано

TomDoc — это спецификация документирования для написания понятных и легко читаемых комментариев к коду.

Пример заголовка метода (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

Теги видимости (Visibility Tags)

  • Public: Доступно для использования внешними пользователями библиотеки.
  • Internal: Используется внутри модулей библиотеки; не является частью публичного API.
  • Deprecated: Запланировано к удалению в будущих версиях.

Аргументы и параметры (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).

Инструкции Yields и Return

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

Сигнатуры методов (Method Signatures)

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

Ссылки

Связанные темы