Ruby中相当于Python文档字符串的是什么？

Question

在Python中，你可以通过使用 obj.__doc__ 来查看一个对象的文档字符串（docstring）。那么在Ruby中，怎么做呢？

Answer 1

我觉得Ruby不支持这个功能。

Answer 2

很遗憾，Ruby没有像Python那样的内置文档字符串。

RDoc看起来很糟糕。RDoc是为了转换成HTML格式而设计的，主要是为了在网页浏览器中阅读，并不是普通的文本。谁喜欢看像HTML那样的源代码呢？YARD要好一些。还有一个叫TomDoc的工具，它使用的只是普通文本。但是这些都比不上Python的文档字符串，后者可以在任何Python控制台中轻松实现自动补全，而且不需要使用任何处理工具。

Answer 3

Ruby没有像Python那样的__doc__功能。通常，他们会使用Rdoc格式来写文档，比如：

# For example, a square or circle.
class Shape
  # A horizontal position.
  def x
  end

  # A vertical position.
  def y
  end
end

Ruby中相当于Python文档字符串的是什么？

5 个回答

撰写回答