6

私はRubyコードを使用して文書化しようとしていましたが、ここまたはここyardで説明されていることを正確に実行しています。

# @param [Integer] the number of trials (>= 0)
# @param [Float] success probability in each trial
def initialize(n, p)
  # initialize...
end

私はまだこの奇妙なエラーを受け取ります

@param tag has unknown parameter name: the
@param tag has unknown parameter name: success

生成されたhtmlは奇妙に見えます。私はyardこれを呼んでいます：

$ yard doc -m markdown

何が間違っているのでしょうか？

4

1 に答える 1

10

docによると@paramタグの形式は

@param [Type] name description

行にパラメータ名が含まれていません（それぞれnとp）

于 2012-07-03T13:34:01.137 に答える