docstrings - python documentation generator

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

Question

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

Answer 1

Desafortunadamente Ruby no tiene Python como docstrings incorporados.

RDoc se ve terrible RDoc está diseñado para ser procesado en formato HTML y leído en el navegador de we. No es texto plano. ¿A quién le gusta leer código fuente similar a HTML? YARD esta mejor También hay TomDoc que usa solo texto plano. Pero ninguno de ellos se compara con las cadenas de documentación de Pythonic que, por ejemplo, permiten el autocompletado simple desde cualquier consola de Python y necesitan usar cualquier herramienta de procesamiento.

Answer 2

Es más fácil documentar en Ruby usando Yard, que admite diferentes etiquetas como :NODOC:

Para documentar su código con Yard, simplemente escriba el comentario sobre su código.

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

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

luego ejecute yard en el directorio de trabajo actual de su proyecto, esto generará el directorio $PWD/doc para usted con un buen conjunto de documentaciones.

Answer 3

No creo que Ruby apoye esto.

Answer 4

Ruby no tiene un __doc__ Python equivalente. A menudo usan el formato Rdoc para la documentación.