오류의 여러 가지 문제점을 문서화하는 올바른 방법

Question

일부 Ruby 클래스에 대한 설명서를 생성하는 데 yard을 사용하고 있습니다.

# @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 

마당 그것은 하나 개의 문서 블록에 동일한 "키"를 충족하는지 여부를 혼동하는 것 같다 이들은 설명에 의해서만 다른 것입니다.