Documenter le code avec l'IA

Coder avec l’aide de l’IA pour les développeurs

Francesca Donadoni

AI Curriculum Manager, DataCamp

Génération de docstring par IA

Demande utilisateur : Écrivez une docstring pour cette fonction

   def sales_trend(self):
       ...        
       if increasing > decreasing:
           return "Increasing trend"
       else:
           return "Decreasing or stable trend"

Réponse du modèle :

 def sales_trend(self):
     """Analyser les données de ventes pour déterminer la tendance générale"""
     [...]

Génération de docstring par IA

Demande utilisateur : Générez une docstring pour cette fonction incluant :
- Une explication simple de ce que fait la fonction.
- Une description de chaque paramètre et de son type.
- Une description de la valeur de retour et de son type.
Réponse du modèle :

Voici une docstring complète que vous pouvez utiliser pour votre fonction :

def sales_trend(self):
    """
    Analyser les données de ventes pour déterminer s'il y a une tendance à la hausse 
    ou une tendance à la baisse/stable au fil du temps.
    [...]
    """

Génération de docstring par IA

Voici une docstring complète que vous pouvez utiliser pour votre fonction :

def sales_trend(self):
    """
    Analyser les données de ventes pour déterminer s'il y a une tendance à la hausse 
    ou une tendance à la baisse/stable au fil du temps.

    Paramètres
    ----------
    self : objet
        Un objet contenant un attribut `daily_sales` (liste d'int ou de float),
        représentant les valeurs de ventes quotidiennes dans l'ordre chronologique.
    [...]
    """

S'adapter aux styles de documentation

Résumer le code dans des README

Demande utilisateur : Générez un fichier README en Markdown qui explique la classe SalesAnalyzer et ses méthodes. Incluez un extrait de code pour aider les utilisateurs à analyser la tendance des ventes sur une période aléatoire.

Réponse du modèle :

Voici un brouillon de README.md pour votre classe SalesAnalyzer :

SalesAnalyzer

La classe SalesAnalyzer offre un moyen simple d'analyser les données de ventes quotidiennes et de détecter si la tendance des ventes est généralement à la hausse ou à la baisse/stable. Cet outil peut être utile pour les entreprises ou les particuliers souhaitant un aperçu rapide de leurs performances de vente au fil du temps.

Messages de commit à partir de diff de code

Demande utilisateur : Rédigez un message de commit pertinent pour ce diff git :

(base) datacamp@test:~/datacamp/docstring-generation$ git diff
+
+        Raises:
+            ValueError: If daily_sales contains non-numeric values.
         """
-        return sum(self.daily_sales)
+        if not all(isinstance(sale, (int, float)) for sale in self.daily_sales):
+            raise ValueError("All sales figures must be numeric.")
+        return sum(sale for sale in self.daily_sales)

Automatiser les notes de version

Autres cas d'utilisation

Passons à la pratique !

Coder avec l’aide de l’IA pour les développeurs