Docstring python

La documentation est essentielle pour que toute programmation comprenne facilement le code. Il est utilisé pour expliquer le but de l'utilisation de toute instruction ou fonction ou classe ou module dans le programme. Il aide le codeur principal à se souvenir de la fonction de n'importe quel code après une longue période, et il aide également d'autres codeurs qui souhaitent travailler sur le même projet. Le codeur utilise une seule ligne de commentaire pour expliquer la partie particulière de la fonction du code sous peu. La chaîne de document Python ou docstring est utilisée pour expliquer la fonction d'un segment particulier du code en détail. La ligne docstring devrait commencer par la lettre majuscule et se terminer par une période. La première ligne du docstring contient une brève description de la documentation généralement. La deuxième ligne du docstring doit être vide pour la grande docstring multi-lignes. Triples citations simples ('”) ou Triple Double Quotes ("" ") sont utilisés pour définir le docstring en python. Le contenu docstring est accessible en utilisant Le document__ attribut de l'objet et utilisant le aider() méthode. La façon de déclarer et d'accéder à Docstring dans Python s'est montré dans ce tutoriel.

Exemple-1: accéder à la docstring d'une fonction en utilisant __doc__ attribut

La façon de déclarer et d'accéder au docstring d'une fonction personnalisée s'est montrée dans le script suivant. Le script suivant calcule le xⁿ où x et n seront retirés de l'utilisateur. Pouvoir () La fonction a défini dans le script pour effectuer la tâche. Ici, le docstring a été défini pour cette fonction. __doc__ L'attribut a été utilisé dans le script pour imprimer le docstring avec la sortie.

Def Power (x, n):
"Calculez X à la puissance n
Lisez les valeurs de X et N à partir des arguments de fonction
et calculer et renvoyer la valeur de x à la puissance n."
retour x ** n
# Prenez la valeur de x
x = int (entrée ('Entrez la valeur de x:'))
# Prenez la valeur de n
n = int (entrée ('Entrez la valeur de n:'))
# Imprimez la valeur de retour de la fonction
Imprimer ("le% d à la puissance% d =% d"% (x, n, puissance (x, n))))
# Imprime la valeur docstrante
Print ("Le contenu du docstring: \ n" + puissance.__doc__)

Sortir:

La sortie suivante sera apparue après avoir exécuté le script ci-dessus.

Exemple-2: accéder à la docstring de la classe et de la méthode en utilisant aider() méthode

La façon de déclarer et d'accéder au docstring du document et les méthodes de cette classe ont montré dans le script suivant. La fonction principale du script est de trier une liste numérique et d'inverser les données de la liste. Une liste numérique de 8 éléments a été déclarée dans la classe, et le docstring a été défini au début de la classe en utilisant des citations simples triples. La méthode sort_list () a été définie dans la classe pour imprimer les données triées de la liste, et le document a défini ce Pour cette méthode. reverse_list () La méthode est définie pour imprimer les données inversées de la liste, et le docstring a également été défini pour cette méthode. aider() La méthode a appelé trois fois à la fin du script pour imprimer le docstring du List_Operations classe, sort_list () méthode, et le reverse_list () méthode.

Class List_Operations:

Class List_Operations:
"
Tri et inversion des données de liste
La classe contient deux méthodes,
La méthode sort_list () trie et imprimera la liste,
La méthode Sort_reverse () inversera et imprimera la liste.
"
# Définir une liste de données numériques
listData = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list (self):
"
Imprimer les valeurs de la liste après le tri
La fonction prendra un objet de liste de données numériques de l'argument,
Trier les valeurs de liste en utilisant la méthode SORT ()
et imprimer les valeurs de la liste triée.
"
# Trier la liste
soi.listData.trier()
# Imprimez la liste triée à l'aide de la boucle
print ("Les valeurs de la liste triée: \ n")
pour la valeur de soi.listData:
imprimer (valeur, "", end = ")
def reverse_list (self):
"
Imprimez les valeurs de la liste après l'inversion
La fonction prendra un objet de liste de données numériques de l'argument,
inverser les valeurs de liste à l'aide de la méthode reverse ()
et imprimer les valeurs de la liste inversée.
"
# Inverser la liste
soi.listData.inverse()
# Imprimez la liste inversée à l'aide de la boucle
print ("Les valeurs de la liste triée: \ n")
pour la valeur de soi.listData:
imprimer (valeur, "", end = ")
# Imprime la valeur docstrante de la classe
aide (List_Operations)
# Créer un objet de la classe
obj = list_operations ()
# Imprime la valeur docstrante de la méthode particulière
Aide (OBJ.sort_list)
# Appelez la méthode pour imprimer la liste triée
obj.sort_list ()

Sortir:

La sortie suivante apparaîtra après avoir exécuté le script. Tout docstring du script a été imprimé pour le premier aider() fonction. Le docstring du sort_list () La méthode a été imprimée pour la seconde aider() fonction.

Exemple-3: Accès à la docstring du module Python intégré

Dans les exemples précédents, le docstring a utilisé dans la classe et la fonction définies par l'utilisateur. Chaque module et classe Python intégrés a son docstring qui explique le but d'utiliser ce module ou fonction particulier. Le codeur du module ou de la fonction définit le docstring pour rendre le code compréhensible pour les utilisateurs. Le script suivant imprimera le docstring prédéfini du module DateTime en utilisant le aider() fonction.

# Importer le module DateTime
Importer DateTime
# Afficher le docstring de DateTime
aide (datetime)

Sortir:

La sortie suivante sera apparue après avoir exécuté le script. Le docstring du module DateTime montre la documentation détaillée de celui-ci pour aider les autres à connaître correctement les fonctions des classes et méthodes définies dans ce module.

Conclusion:

La documentation appropriée est essentielle lorsqu'un module ou une fonction est implémenté dans le but spécifique pour aider l'autre codeur à utiliser le module dans son code pour effectuer la tâche particulière. Si la documentation n'est pas correctement définie pour le module ou la fonction, les autres utilisateurs seront confrontés à des problèmes en l'utilisant. Ainsi, chaque codeur doit utiliser le docstring du document pour fournir des informations détaillées aux autres pour comprendre le code.