Commentaire Python

La définition simple de Future Engineer :

C’est comme des notes explicatives dans ta recette de cuisine ! Tu ajoutes des explications à côté de ton code pour dire ce qu’il fait, pourquoi tu l’as écrit ainsi, ou pour te rappeler comment il fonctionne plus tard.

La définition technique :

Un commentaire est du texte dans le code qui est ignoré lors de l’exécution du programme. En Python, il permet d’expliquer le code, de le documenter et est précédé du symbole # pour une ligne ou entouré de  »’ pour plusieurs lignes.

Commentaire Python: QUAND L'UTILISER ?

Pour expliquer du code complexe
Pour documenter des fonctions
Pour désactiver temporairement du code
Pour laisser des notes
Pour faciliter la maintenance

Commentaire Python: LES CAS D'USAGES

Documentation de fonctions
Explications d'algorithmes
Rappels pour la maintenance
Notes de version
Instructions pour l'équipe

Commentaire Python: LES MÉTIERS LIÉS

Développeur Open Source - Documente pour la communauté
Lead Developer - Maintient la qualité du code
QA Engineer - Vérifie la documentation
Développeur Backend - Documente les API
Développeur Junior - Apprend les bonnes pratiques

Commentaire Python: les questions les plus fréquentes

Utilisez # pour une ligne ou  »’ pour plusieurs lignes.
Non, commentez ce qui n’est pas évident, le code simple doit parler de lui-même.
# commente une seule ligne,  »’ permet de commenter plusieurs lignes d’un coup.

CITIZEN CODE : UNE AVENTURE POUR APPRENDRE LE CODE EN S'AMUSANT !

Dans Citizen Code Python, tu construis ta ville, quartier par quartier. En véritable architecte, tu relèves les défis qui te sont lancés à chaque épisode.
Les victoires que tu remportes tout au long de ton aventure te font gagner des Citizen Coins, qui, eux, te permettent de faire évoluer ton avatar.