preguntar acerca de docstring

Quoi, à votre avis, est un docstring significatif? Qu'attendez-Vous d'être décrite? Par exemple, considérez __init__ de cette classe Python: def __init__(self, name, value, displayName=None, matchingRule="strict"): """ name - field name …

donc j'essaye de créer un docstring" dynamique " qui est quelque chose comme ceci: ANIMAL_TYPES = ["mammals", "reptiles", "other"] def func(animalType): """ This is a sample function. @param animalType: "It takes one of these animal types %s" …

j'aime que doxygen crée de la documentation de code C ou PHP. J'ai un projet Python à venir et je pense que je me souviens que Python n'a pas de commentaires /* .. */ , et a aussi sa propre facilité d'auto-documentation qui semble être la façon pytho …

je commence actuellement avec Python et j'ai un fond PHP fort et en PHP j'ai pris l'habitude d'utiliser javadoc comme modèle de documentation. je me demandais si javadoc avait sa place comme docstring documentation en Python. Est quelque ch …

j'ai des classes Python avec des attributs d'objet qui ne sont déclarés que dans le cadre de l'exécution du constructeur, comme ceci: class Foo(object): def __init__(self, base): self.basepath = base temp = [] for …