ruby - poner - meta keywords ejemplos

¿Cómo debo proporcionar documentación YARD/RDoc para los argumentos de palabras clave de Ruby?

Question

Para un método básico de Ruby, proporcionaría documentos de estilo YARD para los parámetros en el siguiente formato.

# @param query [String] The search string to query.
# @param options [Hash] Optional search preferences.
def search(query, options = {})
  # ...
end

Con Ruby 2.0, ahora se pueden utilizar argumentos de palabras clave. Sin embargo, no estoy seguro de cómo enfocar eso en términos de la documentación de YARD.

def search(query, exact_match: false, results_per_page: 10)
  # ...
end

¿Cómo documentaría para exact_match y exact_match en el segundo escenario? ¿Debo seguir usando la palabra clave @param o hay algo mejor?

Answer 1

YARD reconoce argumentos de palabras clave. Esto debería funcionar:

# @param query [String] The search string
# @param exact_match [Boolean] whether to do an exact match
# @param results_per_page [Integer] number of results
def search(query, exact_match: false, results_per_page: 10)
  # ...
end