RubyのPython docstringに相当するものは何ですか？

Question

Pythonでは、obj.__doc__を使用してオブジェクトのdocstringにアクセスできます。 Rubyでの同等のアクションは何ですか？

Answer 1

RubyにはPython __doc__同等。彼らはしばしばドキュメントに Rdoc Format を使用します。

Answer 2

残念ながら、Rubyには組み込みのdocstringのようなPythonはありません。

RDocはひどいようです。 RDocは、HTML形式に処理され、ブラウザで読み取られるように設計されています。プレーンテキストではありません。 HTMLのようなソースコードを読むのが好きな人は誰ですか？ヤードの方がいいです。プレーンテキストのみを使用する TomDoc もあります。しかし、それらのどれも、例えば、Pythonicdocstringsと比較しません。任意のpythonコンソールからの単純なオートコンプリートを可能にし、任意の処理ツールを使用する必要があります。

Answer 3

:NODOC:のようなさまざまなタグをサポートするYardを使用してRubyで文書化する方が簡単です。

Yardを使用してコードを文書化するには、コードの上にコメントを記述します。

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

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

次に、プロジェクトの現在の作業ディレクトリでyardを実行します。これにより、ドキュメントの素晴らしいセットを含む$PWD/docディレクトリが生成されます。

Answer 4

Rubyがこれをサポートしているとは思わない。