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

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

Пример:

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

Ответы

Ответ 1

Чтобы отметить параметр, вы можете просто использовать @param optional (см. http://rubydoc.info/docs/yard/file/docs/Tags.md). Насколько мне известно, теперь можно отметить значение по умолчанию; вы, вероятно, лучше всего поместить его в описание ( "число в квадрат, по умолчанию равно 2" )

Ответ 2

YARD теперь автоматически поддерживает параметры по умолчанию.

YARD автоматически определяет значение по умолчанию, основанное на определении метода. Sweedish!

Например, следующая документация по коду приведет к последующему документу YARD:

Документация кода

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

Результирующая документация YARD

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