Mit ‚Hof‘, wie kann ich einen Platzhalter Parameter wie dokumentieren „def foo (* args)“

Question

Sagen, ich habe eine Methode wie diese

# @return [Integer] number of arguments provided to the method 
def return_number_of_arguments(*args) 
    return args.length 
end 

Wie könnte ich hinzufügen @param Dokumentation?

Ideen ich habe:

@param [*Object] any objects 

aber ich konnte nichts in the yard docs

Answer 1

Da args zu einem Array innerhalb der Methode Körper splatted wird finden, würde ich

# @param args [Array] elements to count 
# @return [Integer] number of arguments provided to the method 
def return_number_of_arguments(*args) 
    return args.length 
end 

schreiben