我想为使用Tomdoc的方法编写文档。我有一个通过调用yield来使用块的方法。
我不知道应该如何记录它。我是否应该在我的方法中添加&block参数，即使我不使用变量本身，所以我可以在方法参数中列出它？或者我应该用tomdoc以不同的方式编写它？
谢谢！
答案 0 :(得分：2)
仅在必须使用&block时，因为创建它的开销可能很大，如果频繁调用此方法，则会导致问题。
通常，最好记录有问题的方法可以采用一个块，并始终具体说明该块的使用方式。由于Ruby块通常不作为特定参数传递，因此&block表示法仅在您持续捕获块以供以后使用或将其转发到另一个方法时才有用。
如果块是必需的或可选的，请务必在文档中清楚地通信。明确地将它放在参数中意味着它是必需的。