ruby - inglés - Marque un parámetro como opcional(o tiene un valor predeterminado) con YARD

yard en inglés

Question

Estoy usando YARD para documentar mi código. Tengo un método que tiene un parámetro opcional con un valor predeterminado. ¿Cómo notifico que el parámetro es opcional y tiene un valor predeterminado?

Ejemplo:

# Squares a number
# 
# @param the number to square
def square_a_number(number = 2)
  number * number
end

Answer 1

YARD ahora es compatible con los parámetros predeterminados automáticamente.

YARD calcula automáticamente el valor predeterminado basado en la definición del método. Sueco

Por ejemplo, la siguiente documentación de código producirá el documento YARD posterior:

Código de Documentación

# Squares a number.
# 
# @param [Integer] number The number to square.
#
def square_a_number(number = 2)
  number * number
end

Documentación YARD resultante

Parameters:
  number (Integer optional) (defaults to: 2)

Answer 2

Para marcar un parámetro es una opción, simplemente puede usar @param optional (consulte http://rubydoc.info/docs/yard/file/docs/Tags.md ). Que yo sepa, ahora hay una manera de indicar un valor predeterminado; Probablemente sea mejor ponerlo en la descripción ("el número al cuadrado, el valor predeterminado es 2")