ruby - 使用 YARD 将参数标记为可选(或具有默认值)

Question

我正在使用 YARD 来记录我的代码。我有一个方法，它有一个带有默认值的可选参数。如何标记该参数是可选的并具有默认值？

例子:

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

Answer 1

YARD 现在自动支持参数默认值。

YARD 根据方法定义自动计算出默认值。瑞典语!

例如，以下代码文档将生成后续的 YARD 文档:

代码文档

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

生成的 YARD 文档

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