Cách tốt nhất để ghi lại thông số "splatted" với YARD?

Question

Tôi có một phương pháp mà nên tận 1+ thông số của bất kỳ lớp, tương tự như Array#push:

def my_push(*objects) 
    raise ArgumentError, 'Needs 1+ arguments' if objects.empty? 
    objects.each do |obj| 
    puts "An object was pushed: #{obj.inspect}" 
    @my_array.push obj 
    end 
end 

cách tốt nhất để ghi lại các thông số phương pháp sử dụng cú pháp YARD là gì?

Edit:

Tôi nhận ra rằng câu hỏi ban đầu của tôi là một chút quá mơ hồ và không khá rõ những gì tôi đang tìm kiếm.

Câu hỏi hay hơn là, cách tốt nhất để xác định tính chất của phương pháp (1-∞ trong trường hợp này) trong YARD khi sử dụng thông số được chia nhỏ là gì? Tôi biết tôi chỉ có thể chỉ định nó trong văn bản, nhưng nó có vẻ như có nên là một thẻ hoặc một cái gì đó tương tự như xác định sự tinh thần.

Answer 1

Tác giả của YARD, lsegal, tuyên bố rằng the appropriate thing to do is provide an @overload for expected invocations. Tuy nhiên, điều này thực sự không cung cấp nhiều sự rõ ràng trong trường hợp phương thức giống như Array#push.

Tôi khuyên bạn nên sử dụng thẻ @param và sử dụng Array<Object> làm loại đối số hoặc cung cấp @overload trông đẹp mắt.

Dưới đây là một so sánh của hai:

class Test 
    # A test method 
    # 
    # @param [Array<Object>] *args Any number of Objects to push into this collection 
    # @return nil 
    def push(*args); end 

    # Another test method 
    # 
    # @overload push2(obj, ...) 
    # @param [Object] obj An Object to push 
    # @param [Object] ... More Objects 
    def push2(*args); end 
end