ruby - 记录多个错误原因的正确方法

Question

我正在使用yard为一些 Ruby 类生成文档。

我们可以记录一些可以通过如下方法引发的错误：

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

这是一个好方法吗？还有更好的吗？

Answer 1

我建议在markdown发生相同异常时使用标记来指定不同的情况，而不是yard内部：

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

Yard 似乎对它是否在一个文档块中遇到相同的“键”感到困惑，这只是解释上的不同。