Что является эквивалентом строки документации Python в Ruby?

Question

В Python вы можете получить доступ к строке документации объекта, используя obj.__doc__.Что такое эквивалентное действие в Ruby?

Answer 1

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

Answer 2

К сожалению, в Ruby нет встроенных строк документации, подобных Python.

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

Answer 3

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

Answer 4

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

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

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

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

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