一千萬個為什麽

搜索

使用YARD將參數標記為可選(或具有默認值)

我正在使用YARD來記錄我的代碼。我有一個方法,它有一個帶有默認值的可選參數。如何表示參數是可選的並且具有默認值?

例:

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

最佳答案

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)

轉載註明原文: 使用YARD將參數標記為可選(或具有默認值)