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 は、説明だけが異なる 1 つのドキュメント ブロックで同じ「キー」に一致するかどうか、混乱しているようです。