[Python] Façon officielle de documenter les Class Attributes ?
Façon officielle de documenter les Class Attributes ? [Python] - Python - Programmation
Sujets relatifs:
- argsort axis=1 python
- Alerte mise à jour Python
- [C#] Class, Struct, c'est quoi maintenant la différence ?
- fermer une fenetre en PYTHON ?
- [python]faire une dll ou équivalent pour accès par labview
- When deployed to Heroku, python setup.py egg info did not run successf
- Script bash/python extraire données bdd
- Decorators in Python
- Raccourci bureau en Python
- erreur requete ldap depuis python
Marsh Posté le 15-06-2023 à 23:13:10
Bonjour,
J'ai 0 expérience en Python, je souhaiterais savoir quel est la façon officielle de documenter les attributs de classes en Python, par exemple la syntaxe suivante fonctionne bien dans PyCharm :
class MyClass:
"""Documentation de la classe.
Attributes:
is_happy (bool): Il est content.
"""
Par contre si je génère une documentation avec pdoc, l'attribut est ignoré.
La documentation de pdoc dit qu'il faut utiliser une docstring lors de la déclaration de l'attribut :
class MyClass:
"""Documentation de la classe."""
def __init__(self):
self.is_happy = True
"""Il est content."""
Ça fonctionne dans pdoc et pycharm, sauf que dans PyCharm la coloration syntaxique colore le commentaire comme une String et pas comme un commentaire, de plus cette syntaxe a fait partie d'une spécification qui a été rejetée : PEP 224
Donc comment est-on sensé faire pour être en règle/state-of-the-art ?
Message édité par rorosk le 15-06-2023 à 23:15:22