Referência rápida

Folha de Dicas do TomDoc

Guia de referência rápida para o padrão de documentação de código TomDoc em Ruby: cabeçalhos de métodos, argumentos e visibilidade.

· Publicado

TomDoc é uma especificação de documentação para escrever comentários de código claros e legíveis por humanos.

Exemplo de cabeçalho de método (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

Tags de visibilidade (Visibility Tags)

  • Public: Disponível para consumo por usuários externos da biblioteca.
  • Internal: Usado internamente entre módulos; não faz parte da API pública.
  • Deprecated: Programado para remoção em versões futuras.

Argumentos e opções (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).

Declarações 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.

Assinaturas de métodos (Method Signatures)

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

Referências

Temas relacionados