AI के साथ कोड डॉक्युमेंट करना

डेवलपर्स के लिए AI-असिस्टेड कोडिंग

Francesca Donadoni

AI Curriculum Manager, DataCamp

AI-संचालित docstring जनरेशन

User prompt: इस फंक्शन के लिए एक docstring लिखें

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

Model's response:

 def sales_trend(self):
     """Analyze sales data to determine the overall trend"""
     [...]

AI-संचालित docstring जनरेशन

User prompt: ऐसी docstring जनरेट करें जो इस फंक्शन के लिए शामिल करे:
- फंक्शन क्या करता है इसकी सरल व्याख्या.
- हर पैरामीटर और उसके टाइप का विवरण.
- रिटर्न वैल्यू और उसके टाइप का विवरण.
Model's response:

यहाँ आपकी फंक्शन के लिए पूरी docstring है:

def sales_trend(self):
    """
    Analyze the sales data to determine whether there is an increasing trend 
    or a decreasing/stable trend over time.
    [...]
    """

AI-संचालित docstring जनरेशन

यहाँ आपकी फंक्शन के लिए पूरी docstring है:

def sales_trend(self):
    """
    Analyze the sales data to determine whether there is an increasing trend 
    or a decreasing/stable trend over time.

    Parameters
    ----------
    self : object
        An object that contains an attribute `daily_sales` (list of int or float),
        which represents daily sales values in chronological order.
    [...]
    """

डॉक्यूमेंटेशन स्टाइल्स के अनुरूप बनना

कोड को संक्षेप में README में बदलना

User prompt: Markdown में एक README फाइल जनरेट करें जो SalesAnalyzer क्लास और इसकी मेथड्स समझाए। एक सैंपल कोड स्निपेट शामिल करें जिससे यूज़र रैंडम अवधि में सेल्स ट्रेंड analyze कर सकें.

Model's response:

आपके SalesAnalyzer क्लास के लिए एक परिष्कृत README.md ड्राफ्ट यह रहा:

SalesAnalyzer

SalesAnalyzer क्लास रोज़ाना के सेल्स डेटा का सरल विश्लेषण करने और यह पहचानने का तरीका देता है कि ट्रेंड सामान्यतः बढ़ रहा है या घट रहा/स्थिर है। यह टूल उन व्यवसायों या व्यक्तियों के लिए उपयोगी है जो समय के साथ अपने सेल्स परफॉर्मेंस का त्वरित, हाई-लेवल ओवरव्यू चाहते हैं।

कोड डिफ से कमिट मैसेज

User prompt: इस 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)

रिलीज़ नोट्स का ऑटोमेशन

अन्य उपयोग मामले

अभ्यास करते हैं!

डेवलपर्स के लिए AI-असिस्टेड कोडिंग