Documentation YARD pour une méthode qui retourne une classe

Question

Je dois marquer le type @return d'une méthode qui renvoie une classe au lieu d'une instance. Exemple:

# @return [String] # This implies that the return type is a String object 
def string_class 
    String   # The method actually returns the String class itself 
end 

Est-ce que YARD ont une norme pour cela? Ma première estimation était @return [Class<String>] mais je n'ai pas été en mesure de trouver de la documentation pour quelque chose comme ça.

Answer 1

Selon l'équipe de YARD eux-mêmes, la meilleure façon de documenter la L'exemple fourni est Class<String>. Référence: https://github.com/lsegal/yard/issues/1109

Answer 2

En ruby, (presque) tout est un objet, y compris les classes elles-mêmes!

String.class == Class 

(Il y a a class called Class, dont String est une instance.) Par conséquent, vous pouvez documenter la méthode comme ceci:

# @return [Class] 
def string_class 
    String 
end