Code documenteren met AI

AI-ondersteund coderen voor developers

Francesca Donadoni

AI Curriculum Manager, DataCamp

AI-gestuurde docstring-generatie

Gebruikersprompt: Schrijf een docstring voor deze functie

   def sales_trend(self):
       ...        
       if increasing > decreasing:
           return "Stijgende trend"
       else:
           return "Dalende of stabiele trend"

Reactie van het model:

 def sales_trend(self):
     """Analyseer verkoopgegevens om de algemene trend te bepalen"""
     [...]

AI-gestuurde docstring-generatie

Gebruikersprompt: Genereer een docstring voor deze functie die het volgende bevat:
- Een eenvoudige uitleg van wat de functie doet.
- Een beschrijving van elke parameter en het type.
- Een beschrijving van de retourwaarde en het type.
Reactie van het model:

Hier is een complete docstring die je kunt gebruiken voor je functie:

def sales_trend(self):
    """
    Analyseer de verkoopgegevens om te bepalen of er een stijgende trend is 
    of een dalende/stabiele trend over tijd.
    [...]
    """

AI-gestuurde docstring-generatie

Hier is een complete docstring die je kunt gebruiken voor je functie:

def sales_trend(self):
    """
    Analyseer de verkoopgegevens om te bepalen of er een stijgende trend is 
    of een dalende/stabiele trend over tijd.

    Parameters
    ----------
    self : object
        Een object dat een attribuut `daily_sales` bevat (lijst van int of float),
        wat dagelijkse verkoopwaarden in chronologische volgorde vertegenwoordigt.
    [...]
    """

Aanpassen aan documentatiestijlen

Code samenvatten in READMEs

Gebruikersprompt: Genereer een README-bestand in Markdown dat de SalesAnalyzer-klasse en zijn methoden uitlegt. Voeg een voorbeeldcodefragment toe om gebruikers te helpen de verkooptrend over een willekeurige periode te analyseren.

Reactie van het model:

Hier is een gepolijste README.md-ontwerp voor je SalesAnalyzer-klasse:

SalesAnalyzer

De SalesAnalyzer-klasse biedt een eenvoudige manier om dagelijkse verkoopgegevens te analyseren en te detecteren of de verkooptrend over het algemeen stijgend of dalend/stabiel is. Dit hulpmiddel kan nuttig zijn voor bedrijven of individuen die snel een globaal overzicht van hun verkoopprestaties over tijd willen.

Commitberichten van codeverschillen

Gebruikersprompt: Schrijf een betekenisvol commitbericht voor deze git diff:

(base) datacamp@test:~/datacamp/docstring-generation$ git diff
+
+        Raises:
+            ValueError: Als daily_sales niet-numerieke waarden bevat.
         """
-        return sum(self.daily_sales)
+        if not all(isinstance(sale, (int, float)) for sale in self.daily_sales):
+            raise ValueError("Alle verkoopcijfers moeten numeriek zijn.")
+        return sum(sale for sale in self.daily_sales)

Release-opmerkingen automatiseren

Andere toepassingen

Laten we oefenen!

AI-ondersteund coderen voor developers