Code mit KI dokumentieren

KI-gestütztes Programmieren für Entwickler

Francesca Donadoni

AI Curriculum Manager, DataCamp

KI-gestützte Docstring-Erstellung

Benutzeranfrage: Schreibe einen Docstring für diese Funktion

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

Antwort des Modells:

 def sales_trend(self):
     """Verkaufsdaten analysieren, um den allgemeinen Trend zu bestimmen"""
     [...]

KI-gestützte Docstring-Erstellung

Benutzeranfrage: Erstelle einen Docstring für diese Funktion, der Folgendes enthält:
- Eine einfache Erklärung, was die Funktion macht.
- Eine Beschreibung jedes Parameters und seines Typs.
- Eine Beschreibung des Rückgabewerts und seines Typs.
Antwort des Modells:

Hier ist ein vollständiger Docstring, den du für deine Funktion verwenden kannst:

def sales_trend(self):
    """
    Analysiere die Verkaufsdaten, um festzustellen, ob es einen steigenden 
    oder einen fallenden/stabilen Trend über die Zeit gibt.
    [...]
    """

KI-gestützte Docstring-Erstellung

Hier ist ein vollständiger Docstring, den du für deine Funktion verwenden kannst:

def sales_trend(self):
    """
    Analysiere die Verkaufsdaten, um festzustellen, ob es einen steigenden 
    oder einen fallenden/stabilen Trend über die Zeit gibt.

    Parameter
    ----------
    self : Objekt
        Ein Objekt, das ein Attribut `daily_sales` (Liste von int oder float) enthält,
        das die täglichen Verkaufswerte in chronologischer Reihenfolge darstellt.
    [...]
    """

Anpassung an Dokumentationsstile

Code in READMEs zusammenfassen

Benutzeranfrage: Erstelle eine README-Datei in Markdown, die die SalesAnalyzer-Klasse und ihre Methoden erklärt. Füge einen Beispielcode hinzu, um Nutzern zu helfen, den Verkaufstrend über einen zufälligen Zeitraum zu analysieren.

Antwort des Modells:

Hier ist ein Entwurf für dein README.md für die SalesAnalyzer-Klasse:

SalesAnalyzer

Die SalesAnalyzer-Klasse bietet eine einfache Möglichkeit, tägliche Verkaufsdaten zu analysieren und festzustellen, ob der Verkaufstrend allgemein steigt oder fällt/stabil ist. Dieses Tool kann für Unternehmen oder Einzelpersonen nützlich sein, die einen schnellen Überblick über ihre Verkaufsleistung im Laufe der Zeit wünschen.

Commit-Nachrichten aus Code-Diffs

Benutzeranfrage: Schreibe eine aussagekräftige Commit-Nachricht für diesen 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)

Release Notes automatisieren

Weitere Anwendungsfälle

Lass uns üben!

KI-gestütztes Programmieren für Entwickler