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

Question

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

例子：

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

score 65 · Accepted Answer

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

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

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

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

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

score -1 · Accepted Answer

标记参数是您可以简单地使用的选项@param optional（请参阅http://rubydoc.info/docs/yard/file/docs/Tags.md）。据我所知，现在有一种方法可以标注默认值；你可能最好把它放在描述中（“平方数，默认为 2”）