0
내가이 말은이, 어떻게 내가 "(* 인수) 데프 foo는"같은 와일드 카드 매개 변수를 문서화 할 수
# @return [Integer] number of arguments provided to the method
def return_number_of_arguments(*args)
return args.length
end
같은 방법은 어떻게 @param
문서를 추가 할 수 있습니다?
아이디어는 내가 가진 :
@param [*Object] any objects
하지만, 내가 써서 args
이 메소드 본문 내에서 Array
에 splatted되기 때문에 the yard docs
나는 이것이 무엇을 가리키는 지 알지 못한다. 예를 들어, 메소드가 연속적인 문자열 인수를 여러 개 사용하면 배열을 취하는 것으로 문서화하는 것이 비생산적인 결과를 낳을 수 있습니다. –
@maxpleaner 귀하의 요지를 봅니다. 전달 된 인수가 내부적으로 처리되는 방법을 살펴 보겠습니다. API 문서의 POV가 꼭 필요한 것은 아닙니다. 분명히 그것을 위해'@ overload' 태그가 존재합니다. http://stackoverflow.com/questions/30416185/best-way-to-document-splatted-parameter-with-yard?rq=1을보십시오. – carp