Question

我需要标记返回类而不是实例的方法的@return类型。例如：

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

有关返回类的方法的YARD文档

2 个答案: