Programmation PYTHON - Zenk - Security - Repository

200
Éléments du langage
DEUXIÈME PARTIE
Commentaires simples
Les commentaires simples sont des lignes insérées dans la continuité du code et
constituant des phrases complètes. Le point de fin de phrase est retiré.
Commentaires simples
# Préparation des données du XF4 et normalisation
datas = get_datas(2)
normalized_datas = normalize_xf4(datas)
Commentaires en fin de ligne
Les commentaires en fin de ligne sont distants d’au moins deux espaces de la fin du
code et commencent par un caractère dièse (#) suivi d’un espace. Ils sont en général
très courts et doivent avoir une valeur ajoutée, c’est-à-dire ne pas se contenter de
répéter en français ce que le code de la ligne fait.
Ils sont préférés aux commentaires simples pour des remarques concernant l’implémentation.
Utilisation d’un commentaire en ligne
resultat = resultat.strip() # des espaces en trop altèrent la lisibilité
# à éviter:
resultat = resultat * 2 # le résultat est multiplié par deux
Blocs de commentaires
Un bloc de commentaires est en général utilisé pour expliquer le fonctionnement et
l’objectif de la portion de code. Si le texte est constitué de plusieurs paragraphes, une
ligne de commentaire vide les sépare. Un saut de ligne est inséré avant et parfois
après le bloc lorsqu’il est nécessaire d’accentuer l’importance de ce commentaire.
Exemple d’utilisation d’un bloc
if kw.has_key('autolayout'):
# Mise en place d'un affichage auto
# pour l'instant sur trois colonnes
#
# Pourra être plus perfectionné
# par la suite.