Commentaire : Texte dans le code qui n'est pas exécuté mais sert à expliquer le fonctionnement du programme.
- Utiliser le symbole # pour les commentaires simples
- Placer le commentaire sur la même ligne ou ligne précédente
- Expliquer le "pourquoi" plutôt que le "quoi"
- Écrire en français ou en anglais selon le contexte
- Restez concis mais clair
| Type de commentaire | Syntaxe | Usage |
|---|---|---|
| Simple ligne | # Commentaire | Explication courte |
| Multi-ligne | # Ligne 1 # Ligne 2 |
Explication détaillée |
| Bloc | """...""" | Docstrings |
Expliquer les algorithmes ou les décisions de conception
Justifier les choix techniques ou les solutions choisies
Expliquer pourquoi certaines lignes de code existent
Commentaires pertinents qui expliquent le "pourquoi" et le "comment" du code
• Pertinence : Les commentaires doivent apporter de la valeur
• Clarté : Écrire dans un langage simple et compréhensible
• Maintenance : Mettre à jour les commentaires avec le code
Docstring : Chaîne de caractères littérale placée en premier dans une fonction, classe ou module pour documenter ce composant.
Expliquer ce que fait la fonction en une phrase claire
Indiquer le type et la signification de chaque paramètre avec Args
Décrire ce que la fonction renvoie avec Returns
Indiquer les erreurs potentielles avec Raises si applicable
Docstrings complets conformes aux conventions PEP 257
• Triple guillemets : Utiliser """ pour les docstrings
• Formatage : Respecter la structure Args, Returns, Raises
• Clarté : Écrire des descriptions claires et précises
Documentation de classe : Ensemble de commentaires et docstrings décrivant le comportement, les attributs et les méthodes d'une classe.
Expliquer le but et les responsabilités de la classe
Décrire chaque attribut important de la classe
Fournir des docstrings pour toutes les méthodes publiques
Détailler ce que font les méthodes et ce qu'elles retournent
Classe entièrement documentée avec docstrings pour tous les éléments publics
• Clarté : Expliquer le rôle de la classe et de ses méthodes
• Complétude : Documenter tous les attributs et méthodes publics
• Concision : Être clair sans être verbeux
Documentation de module : Commentaires placés au début d'un fichier pour décrire son contenu et son usage.
Expliquer le but et les fonctionnalités du module
Fournir une brève description de chaque fonction exportée
Inclure l'auteur, la date, la version et autres infos pertinentes
Chaque fonction du module doit avoir son propre docstring
Module entièrement documenté avec description générale et détails des fonctions
• Position : Docstring du module en première ligne du fichier
• Contenu : Description du module, des fonctions et des métadonnées
• Clarté : Information utile pour les utilisateurs du module
PEP 257 : Norme Python pour la documentation des docstrings, définissant les conventions de style et de format.
Utiliser triple guillemets doubles pour les docstrings
Suivre la structure Args, Returns, Raises, Examples
Phrase impérative à la racine, description détaillée ensuite
Appliquer les mêmes conventions dans tout le projet
Documentation conforme aux conventions PEP 257
• Triple guillemets : Toujours utiliser """
• Structure : Args, Returns, Raises dans cet ordre
• Phrases impératives : "Return" au lieu de "Returns"
- Expliquer le "pourquoi" : Plutôt que le "quoi", expliquer la logique derrière le code
- Soigner les docstrings : Ils sont essentiels pour la documentation automatique
- Éviter les commentaires évidents : Ne pas commenter ce qui est évident
- Utiliser des exemples : Montrer comment utiliser les fonctions avec des exemples
- Restez concis : Être clair et bref sans sacrifier la précision
- La documentation doit être aussi importante que le code
- Les docstrings doivent être en triple guillemets
- Respecter les conventions PEP 257 pour la structure
- Documenter les paramètres, les valeurs de retour et les exceptions
- Utiliser un langage clair et accessible