Что такое эквивалент Python docstring в Ruby?

Ответ 1

Ruby не имеет эквивалента Python __doc__. Они часто используют формат Rdoc для документации.

Ответ 2

Unfortunatelly Ruby не имеет никаких Python, как встроенные docstrings.

RDoc выглядит ужасно. RDoc предназначен для обработки в формате HTML и чтения в браузере. Это не обычный текст. Кому нравится читать HTML-подобный исходный код? Ярд лучше. Существует также TomDoc, которые используют только обычный текст. Но ни один из них не сравнится с пифоновскими докстерами, например, позволяют простое автозаполнение с любой консоли python и нужно использовать любой инструмент обработки.

Ответ 3

Я не считаю, что Ruby поддерживает это.

Ответ 4

Легче документировать в Ruby с помощью Yard, который поддерживает различные теги, такие как :NODOC:

Чтобы документировать свой код с помощью Yard, просто напишите комментарий над своим кодом.

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

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

затем запустите yard в текущем рабочем каталоге вашего проекта, это создаст каталог $PWD/doc для вас с хорошим набором документов.