Docstring : Chaîne de caractères au début d'une fonction décrivant son utilité.
- Écrire une docstring triple guillemet en première ligne de la fonction
- Indiquer la description, les paramètres et la valeur de retour
- Ajouter des exemples d'utilisation si nécessaire
- Utiliser des commentaires pour expliquer les parties complexes
Expliquer ce que fait la fonction, ses paramètres et sa valeur de retour.
Expliquer les parties complexes de l'algorithme.
Montrer comment utiliser la fonction avec des données concrètes.
Une fonction bien documentée contient une docstring décrivant son usage et des commentaires internes pour les parties complexes.
• Structure : Description, paramètres, retour, exemples
• Clarté : Langage simple et descriptif
• Exhaustivité : Tous les aspects de la fonction sont documentés
Documentation de module : Ensemble d'informations en tête de fichier décrivant l'ensemble des fonctions.
Écrire une docstring en haut du fichier décrivant l'objectif.
Inclure une section avec les fonctions disponibles.
Ajouter des commentaires pour les variables globales.
Un module bien documenté commence par une description générale suivie de la documentation des éléments qu'il contient.
• Contexte : Expliquer le but du module
• Structure : Organiser les informations de manière logique
• Complétude : Documenter tous les éléments publics
Algorithme documenté : Code annoté pour expliquer la logique de chaque étape.
Donner un aperçu général de la méthode utilisée.
Expliquer chaque phase de l'algorithme avec des commentaires.
Fournir un cas d'utilisation pour clarifier le fonctionnement.
Un algorithme bien documenté explique sa logique et comment chaque étape contribue au résultat final.
• Logique : Expliquer la stratégie de l'algorithme
• Clarté : Utiliser des commentaires pour les parties complexes
• Illustration : Fournir des exemples d'utilisation
Outils de documentation : Logiciels qui génèrent automatiquement de la documentation à partir du code.
Utiliser un format standardisé (comme Napoleon pour Sphinx).
Installer et configurer l'outil de génération de documentation.
Exécuter l'outil pour produire la documentation finale.
Les outils de documentation automatique transforment les docstrings en documentation formatée.
• Standardisation : Suivre les conventions de l'outil utilisé
• Complétude : Documenter tous les éléments publics
• Maintenance : Garder la documentation à jour avec le code
Maintenance de documentation : Mettre à jour la documentation lors des modifications du code.
Détecter les modifications apportées au code.
Adapter les docstrings aux nouvelles fonctionnalités.
Tenir un journal des changements pour suivre l'évolution.
La documentation doit évoluer en même temps que le code pour rester précise et utile.
• Synchronisation : Documentation mise à jour avec le code
• Historique : Tenir un journal des modifications
• Précision : Documenter chaque changement significatif
- Inline : Commentaires dans le code pour les parties complexes
- Fonctionnelle : Docstrings pour les fonctions, classes et modules
- Structurée : Documentation externe avec guides d'utilisation
- Automatique : Génération à partir de docstrings avec des outils
- Clarté : Utiliser un langage simple et descriptif
- Concision : Être bref mais complet
- Actualité : Mettre à jour la documentation avec le code
- Exemples : Fournir des cas d'utilisation concrets
- Chaque fonction publique doit avoir une docstring
- La documentation doit refléter exactement le comportement du code
- Les commentaires doivent expliquer le "pourquoi" pas le "comment"
- La documentation doit être maintenue à jour lors des modifications
- Utiliser des outils pour générer de la documentation automatique