python - RubyのPython docstringに相当するものは何ですか?

Question

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

Answer 1

__doc__Ruby には Pythonに相当するものはありません。多くの場合、ドキュメンテーションにはRdoc 形式 を使用します。

Answer 2

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

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

Answer 3

ruby がこれをサポートしているとは思えません。

Answer 4

次のようなさまざまなタグをサポートする Yard を使用して、Ruby でドキュメント化する方が簡単です。:NODOC:

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

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

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

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