Docstring NumPy

Puisque nous savons déjà comment écrire les commentaires multilignes, nous pouvons soit utiliser les triples guillemets simples, soit les triples guillemets doubles. Nous utilisons une chaîne de documentation lorsque nous voulons décrire nos fonctions afin que nous puissions obtenir la documentation lorsque nous en avons besoin. Certains IDE vous fournissent une documentation en survolant simplement le nom et certains mettent en évidence certains mots-clés. Mais le fait est que les docstrings dans NumPy sont bien plus flexibles que dans d'autres langages. Docstring est un littéral de chaîne qui apparaît au début de la définition de la fonction. Nous devons fournir des valeurs spécifiques lors de l'utilisation des docstrings dans le cas de fonctions, de classes, etc.

Lorsque vous utilisez des docstrings avec des fonctions, nous devons passer les arguments. Lors de leur utilisation avec des classes, nous passons les attributs et les méthodes. Dans le cas des modules, nous devons fournir une liste de classes et de fonctions. Dans le cas du package, nous passons la liste des modules avec fonctionnalité. Donc, fondamentalement, le but de la docstring est, comme son nom l'indique, qu'il aide à la documentation de notre code. Nous faisons de la documentation afin que si quelqu'un utilise notre code à l'avenir, il puisse comprendre notre code et la logique derrière notre code à l'aide de docstring. Les fonctions intégrées contiennent également des docstrings ; nous pouvons utiliser la fonction de help() pour regarder la docstring des fonctions intégrées.

Il existe quelques différences entre les commentaires et les docstrings. Les commentaires sont ignorés par les interpréteurs mais les docstrings ne sont pas ignorés par les interpréteurs. La mémoire est allouée pour les docstrings. Un commentaire est une description du code mais d'un autre côté, les docstrings nous indiquent le but du code.

Syntaxe:

La syntaxe pour écrire les docstrings dans NumPy est :

Veuillez noter que docstring n'est pas une fonction ou une méthode, il n'a donc pas la syntaxe appropriée. La seule chose à noter ici est que nous commençons la docstring avec trois guillemets simples ou trois guillemets doubles. Nous écrivons notre description du code et la terminons à nouveau par trois guillemets simples ou trois guillemets doubles à la fin. Il n'y a rien d'obligatoire à écrire pour les docstrings. Il vous suffit de mettre trois guillemets simples ou doubles avant et après la description de votre chaîne.

Exemple 1:

Pour mieux comprendre les docstrings, prenons un exemple. Dans cet exemple, après avoir inclus la bibliothèque NumPy, nous déclarons simplement la variable 'a' et une autre variable 'b'. Après cela, nous créons notre docstring qui dit « Ajoutons les variables « a » et « b » ». Dans notre cas, c'est un exemple simple mais si notre code est complexe, cela aide beaucoup le codeur à comprendre le code. Après cela, nous additionnons les variables 'a' et 'b' et stockons leur résultat de sortie dans une autre variable qui est 'c'. Enfin, nous imprimons la valeur de la variable 'c'. Maintenant, nous exécutons notre code.

Ceci est notre sortie du morceau de code donné. Nous pouvons voir que le système n'a donné aucune erreur concernant une syntaxe incorrecte ou quoi que ce soit pour la ligne 7 de notre code. De plus, le système n'a pas imprimé notre docstring. Au lieu de cela, il n'a imprimé que la sortie de notre variable 'c' dans laquelle nous avons dit à notre système d'imprimer. Cela montre comment fonctionnent les docstrings. La prochaine fois, lorsqu'un nouveau codeur essaiera de travailler sur notre code, il comprendra ce que nous faisons avec l'aide de notre docstring. Mais il ne sera pas imprimé en sortie afin que l'utilisateur du code ne soit pas dérangé par celui-ci.

Exemple 2 :

Maintenant, nous effectuons un exemple complexe pour comprendre le fonctionnement de la docstring. Tout d'abord, nous incluons la bibliothèque NumPy, puis écrivons une chaîne de documentation dans laquelle nous expliquons la ligne de code suivante où nous expliquons l'initialisation du tableau. Nous ajoutons également les docstrings dans l'autre partie du code. Maintenant, si nous partageons ce code avec n'importe quel nouveau développeur Python sans ajouter les docstrings, il lui sera en quelque sorte difficile de connaître le fonctionnement et le but de ce code. Il doit d'abord rechercher les fonctions que nous avons utilisées. Mais si nous ajoutons une docstring à notre code, il sera facile pour les autres développeurs de comprendre le code sans étudier davantage les fonctions. Nous ne sommes pas limités à ajouter des commentaires à certaines limites ; les commentaires peuvent être d'une ou plusieurs lignes. Il peut également être ajouté plusieurs fois dans un code. Ensuite, importez NumPy en tant que np.

Comme indiqué dans l'extrait de code suivant, les docstrings ne sont pas affichés dans la sortie, ce qui signifie qu'ils n'affectent pas la sortie ou la compilation du code. Les docstrings sont ignorées pendant le processus de compilation.

Conclusion

Dans ce guide, nous avons découvert les docstrings dans NumPy. Nous avons comparé les docstrings avec des commentaires et expliqué la différence entre les deux. Nous avons appris la syntaxe des docstrings et comment écrire les docstrings dans notre code. De plus, nous avons également essayé d'expliquer ce que sont les docstrings dans NumPy et comment elles fonctionnent à l'aide d'exemples. Enfin, nous avons remarqué qu'ils sont essentiels pour les codeurs. Nous ne répéterons pas l'importance des docstrings dans NumPy. Nous dirons simplement que vous devez utiliser les docstrings dans votre code. Dans NumPy, le style d'écriture des docstrings est le plus populaire. Il est largement utilisé dans la communauté de programmation pour se faire connaître le fonctionnement et la fonctionnalité de leurs codes. Ce guide vous aidera à démarrer avec les docstrings NumPy. Nous avons essayé de couvrir la plupart de ce dont vous aurez besoin en utilisant les docstrings dans NumPy.