Пометить параметр как необязательный (или имеющий значение по умолчанию) с помощью YARD

Я использую YARD для документирования своего кода. У меня есть метод, который имеет необязательный параметр со значением по умолчанию. Как отметить, что параметр необязателен и имеет значение по умолчанию?

Пример:

# Squares a number
# 
# @param the number to square
def square_a_number(number = 2)
  number * number
end
23
задан brainimus 21 October 2011 в 16:47
поделиться