Documentare il codice con l'AI

Programmazione assistita dall'AI per sviluppatori

Francesca Donadoni

AI Curriculum Manager, DataCamp

Generazione di docstring con AI

Richiesta utente: Scrivi una docstring per questa funzione

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

Risposta del modello:

 def sales_trend(self):
     """Analizza i dati di vendita per determinare il trend generale"""
     [...]

Generazione di docstring con AI

Richiesta utente: Genera una docstring per questa funzione che includa:
- Una semplice spiegazione di cosa fa la funzione.
- Una descrizione di ogni parametro e del suo tipo.
- Una descrizione del valore di ritorno e del suo tipo.
Risposta del modello:

Ecco una docstring completa che puoi usare per la tua funzione:

def sales_trend(self):
    """
    Analizza i dati di vendita per determinare se c'è un trend in aumento 
    o un trend in diminuzione/stabile nel tempo.
    [...]
    """

Generazione di docstring con AI

Ecco una docstring completa che puoi usare per la tua funzione:

def sales_trend(self):
    """
    Analizza i dati di vendita per determinare se c'è un trend in aumento 
    o un trend in diminuzione/stabile nel tempo.

    Parametri
    ----------
    self : oggetto
        Un oggetto che contiene un attributo `daily_sales` (lista di int o float),
        che rappresenta i valori di vendita giornalieri in ordine cronologico.
    [...]
    """

Adattarsi agli stili di documentazione

Riassumere il codice nei README

Richiesta utente: Genera un file README in Markdown che spieghi la classe SalesAnalyzer e i suoi metodi. Includi un esempio di codice per aiutare gli utenti ad analizzare il trend delle vendite in un periodo casuale.

Risposta del modello:

Ecco una bozza di README.md per la tua classe SalesAnalyzer:

SalesAnalyzer

La classe SalesAnalyzer offre un modo semplice per analizzare i dati di vendita giornalieri e rilevare se il trend delle vendite è generalmente in aumento o in diminuzione/stabile. Questo strumento può essere utile per aziende o individui che desiderano una panoramica rapida delle loro performance di vendita nel tempo.

Messaggi di commit dai diff del codice

Richiesta utente: Scrivi un messaggio di commit significativo dato questo git diff:

(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)

Automatizzare le note di rilascio

Altri casi d'uso

Facciamo pratica!

Programmazione assistita dall'AI per sviluppatori