6

YARD で文書化する最初の gem を書いています。クラスの 1 つに、引数を取らないブロックを期待するコンストラクターを持たせました1。

YARD は、メソッドが渡すパラメーターの観点からブロック引数を記述するタグを提供しますが、リストが空@yield [params] descriptionの場合は適切にフォーマットされません。paramsパラメーターのないブロックをどのように文書化すればよいですか?

1 : 技術的には、私はyieldブロックにさえ ing していません。次のようなコードがあります。

def initialize(&block)
  define_singleton_method(:create, block)
  create
  class << self; undef_method :create; end
end

...そのため、ブロックには、新しく作成されたオブジェクトのコンテキストで実行されるコードが含まれています。これが何らかの理由でひどい考えである場合、私もそれを知ってうれしいです:)

4

1 に答える 1

3

YARD の github ページで古い問題を見つけました。パラメータブロックは省略されるべきであるように見えます:

# @yield Description of the block here
def initialize(&block)
  define_singleton_method(:create, block)
  create
  class << self; undef_method :create; end
end
于 2013-04-22T11:35:03.570 に答える