Je sais quel est le moyen standard de documenter des fonctions, des classes et des modules, mais comment documenter les packages - puis-je mettre un doctrage dans __ init __. py ou autre chose?
3 Réponses :
Oui, comme pour une fonction ou un commentaire de classe, le premier élément de la maintenant si vous Importer le package et utiliser l'aide (paquet), vous verrez votre docstring. En voir plus Vous allez voir ici: http://www.python.org/dev/peps/pep- 0257 /
Voir Pep257
Un package peut être documenté dans le module docstring du fichier __ init __.py dans le répertoire de packages.
documentation est une bonne idée, tant que vous ne documez pas quelque chose d'évident dans votre code
Essayez de comprendre que la plupart des personnes qui lisent votre source comprendront Python, alors commentant ou documenter des lignes comme celle-ci est inutile: mais commentant ou documenter une fonction ou une classe plutôt compliquée est une bonne idée. règle générale du pouce: imaginez la prochaine personne à travailler sur votre code est Une hache maniaque maniaque et ils savent où vous vivez. De cette façon, vous quitterez toujours des commentaires «utiles» / DOC