¿Cuál es el equivalente de una docstring de Python en Ruby?

Question

En Python, puede acceder a la cadena de documentos de un objeto usando obj.__doc__. ¿Cuál es la acción equivalente en Ruby?

Answer 1

Ruby no tiene un equivalente de Python __doc__. A menudo usan Rdoc Format para documentación.

Answer 2

No creo que ruby ​​apoye esto.

Answer 3

Es más fácil documentar en Ruby utilizando el patio, que es compatible con diferentes etiquetas como :NODOC:

Para documentar su código con la yarda, acaba de escribir el comentario anterior el código.

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

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

continuación, ejecute yard en el directorio de trabajo actual de su proyecto, esto va a generar el directorio $PWD/doc para usted con un buen conjunto de documentaciones.

Answer 4

Desafortunadamente, Ruby no tiene ninguna docstrings incorporadas en Python.

RDoc parece terrible. RDoc está diseñado para procesarse en formato HTML y leerse en el navegador. No es texto simple. ¿A quién le gusta leer el código fuente similar al HTML? YARD es mejor. También hay TomDoc que usan solo texto sin formato. Pero ninguno de ellos se compara con documentos Pythonic que p. permite la autocompletación simple desde cualquier consola de Python y necesita usar cualquier herramienta de procesamiento.