我應該在Ruby中調用yield時精確並阻止？

Question

我想爲使用Tomdoc的方法編寫文檔。我有一個通過調用yield來使用塊的方法。

我不知道如何記錄它。我應該爲我的方法添加一個&block參數，即使我不使用變量本身，所以我可以在方法參數中列出它？或者我應該用tomdoc以不同的方式編寫它？

謝謝！

Answer 1

使用&block只有當您必須作爲創建它的開銷可能是重大的，並且如果此方法被稱爲非常頻繁可能會導致問題。

通常最好記錄下所述的方法可以佔用一個塊並且始終具體說明如何使用該塊。由於Ruby塊通常不會作爲特定的參數傳入，因此只有在您始終捕獲該塊供以後使用或將其轉發到另一個方法時，該塊纔有用。

如果需要或可選塊，請務必在文檔中清楚地溝通。明確表明它是必需的。