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

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

例:

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

最佳答案

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

关于ruby - 使用YARD将参数标记为可选(或具有默认值)，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/7852625/