我应该在Ruby中调用yield时精确并阻止？

Question

我想为使用Tomdoc的方法编写文档。我有一个通过调用yield来使用块的方法。

我不知道如何记录它。我应该为我的方法添加一个&block参数，即使我不使用变量本身，所以我可以在方法参数中列出它？或者我应该用tomdoc以不同的方式编写它？

谢谢！

Answer 1

使用&block只有当您必须作为创建它的开销可能是重大的，并且如果此方法被称为非常频繁可能会导致问题。

通常最好记录下所述的方法可以占用一个块并且始终具体说明如何使用该块。由于Ruby块通常不会作为特定的参数传入，因此只有在您始终捕获该块供以后使用或将其转发到另一个方法时，该块才有用。

如果需要或可选块，请务必在文档中清楚地沟通。明确表明它是必需的。