python - 什么是 Ruby 中的 Python 文档字符串？

Question

在 Python 中，您可以使用obj.__doc__. Ruby 中的等效操作是什么？

Answer 1

Ruby 没有 Python__doc__等价物。他们经常使用Rdoc 格式 作为文档。

Answer 2

不幸的是，Ruby 没有任何 Python 之类的内置文档字符串。

RDoc 看起来很糟糕。RDoc 旨在处理成 HTML 格式并在我们的浏览器中读取。它不是纯文本。谁喜欢阅读类似 HTML 的源代码？院子更好。还有只使用纯文本的TomDoc 。但是它们都不能与 Pythonic 文档字符串相比，后者例如允许从任何 Python 控制台进行简单的自动完成，并且确实需要使用任何处理工具。

Answer 3

我不相信红宝石支持这一点。

Answer 4

使用 Yard 在 Ruby 中记录文档更容易，它支持不同的标签，例如:NODOC:

要使用 Yard 记录您的代码，只需在代码上方写下注释即可。

# MyClass.new(...) some comment here
class MyClass
end

# foo("bar")
def foo(bar = nil)
end

然后yard在项目的当前工作目录上运行，这将为$PWD/doc您生成包含一组很好的文档的目录。