使用YARD将参数标记为可选（或具有默认值）

Question

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

示例：

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

Answer 1

YARD现在自动支持param默认值。

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

例如，以下代码文档将生成后续的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)

Answer 2

要标记参数是选项，您只需使用@param optional（请参阅http://rubydoc.info/docs/yard/file/docs/Tags.md）。据我所知，现在有办法表示默认值;你可能最好把它放在描述中（“数字到正方形，默认为2”）