returns a class 方法的 YARD 文档

Question

我需要标记方法的 @return 类型，return 是 class 而不是实例。示例：

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

YARD 有这方面的标准吗？我的第一个猜测是 @return [Class<String>]，但我没能找到类似的文档。

Answer 1

在ruby中，（几乎）一切都是对象，包括类他们自己！

String.class == Class

（有a class called Class，其中String是一个实例。）因此，您可以这样记录方法：

# @return [Class]
def string_class
  String
end

Answer 2

根据 YARD 团队自己的说法，记录所提供示例的首选方式是 Class<String>。参考：https://github.com/lsegal/yard/issues/1109

returns a class 方法的 YARD 文档

YARD documentation for a method that returns a class

ruby

yard