30

コードを文書化するために YARD を使用しています。デフォルト値を持つオプションのパラメーターを持つメソッドがあります。パラメータがオプションであり、デフォルト値があることをどのように表記すればよいですか?

例：

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

2 に答える 2

65

YARD は、param のデフォルトを自動的にサポートするようになりました。

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)
于 2011-12-23T23:59:06.260 に答える
-1

パラメータをマークするには、簡単に使用できるオプションです@param optional( http://rubydoc.info/docs/yard/file/docs/Tags.mdを参照)。私の知る限り、デフォルト値を表記する方法があります。説明に入れるのがおそらく最善です（「二乗する数、デフォルトは2」）

于 2011-10-21T17:13:34.250 に答える