Les commentaires dans un script et la documentation (docstring)

Les commentaires dans un script et la documentation (docstring)

Script script_ex.py

# Ceci est un commentaire sur un script

""" Ceci est un commentaire ou documentation
que j'écris sur plusieurs
lignes """

Exécution du script script_ex.py et appel de la fonction intégrée help ( )

>>> help ("script_ex")
Help on module script_ex:

NAME
    script_ex

DESCRIPTION
    Ceci est un commentaire ou documentation
    que j'écris sur plusieurs
    lignes

FILE
    c:\users\fabricedumont\desktop\script_ex.py


>>> 

Le commentaire sur une seule ligne est précédé d’un carré dièse #.

Le commentaire sur plusieurs lignes doit être entouré de triples guillemets. Lors de l’appel de la fonction help ( ) de ce script, ce commentaire est considéré comme une documentation (docstring)

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *