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

【问题标题】：Correct way to document multiple couses of an error记录多个错误原因的正确方法
【发布时间】：2013-12-26 02:21:34
【问题描述】：

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

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

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

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

【问题讨论】：

标签： ruby documentation yard raise

【解决方案1】：

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

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

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

【讨论】：