Quel est l'équivalent d'un Python docstring en Ruby?
En Python, vous pouvez accéder à un objet de la docstring en utilisant obj.__doc__
. Quel est l'équivalent de l'action en Ruby?
- Eh bien, peut-être que vous devez d'abord se demander si Ruby a docstrings à tous les...
Vous devez vous connecter pour publier un commentaire.
Ruby n'a pas un Python
__doc__
équivalent. Ils utilisent souvent des Rdoc Format pour la documentation.Malheureusement Ruby n'a pas de Python comme intégré dans les docstrings.
RDoc l'air terrible. RDoc est conçu pour être transformé en format HTML et de le lire dans le nous navigateur. Ce n'est pas en texte brut. Qui aime lire HTML code source? COUR, c'est mieux. Il est également TomDoc qui utilisent seulement le texte brut. Mais aucun d'entre eux à comparer à Pythonic docstrings qui, par exemple, permet une auto-complétion partir de n'importe quel console python et ne besoin d'utiliser un outil de traitement.
Je ne crois pas que ruby prend en charge cette.
Il est plus facile de document en Ruby à l'aide de Triage, qui prend en charge les différentes balises comme
:NODOC:
De documenter votre code avec jardin, il suffit d'écrire le commentaire au-dessus de votre code.
puis exécutez
yard
sur le répertoire de travail actuel de votre projet, cela permet de générer le$PWD/doc
répertoire pour vous avec une belle série de documentations.