正確記錄多個錯誤的方法

Question

我正在使用yard爲某些Ruby類生成文檔。

我們可以記錄一些錯誤，可以通過一種方法這樣的方式籌集：

# @raise [ArgumentError] Cause 1 
# @raise [ArgumentError] Cause 2 
# @raise [ArgumentError] Cause 3 
# @raise [ArgumentError] ... 
# @raise [ArgumentError] Cause n 

這是一個好辦法嗎？ 還有更好的嗎？

Answer 1

當同樣的異常情況發生時，而不是yard內部我會建議使用markdown標記來指定不同的情況：

# @raise [ArgumentError] may be thrown in different circumstances: 
# * Cause 1 
# * Cause 2 
# * Cause N 

院子似乎混淆它是否符合一個文件塊相同的「鑰匙」 ，這只是解釋而已。