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似乎很困惑它是否在一个文档块中遇到相同的“键”，这仅仅是解释。

正确的方法来记录错误的多重因素

1 个答案: