การเขียนเอกสารโค้ดด้วย AI

การเขียนโค้ดด้วยความช่วยเหลือของ AI สำหรับนักพัฒนา

Francesca Donadoni

AI Curriculum Manager, DataCamp

การสร้าง docstring ด้วย AI

คำสั่งของผู้ใช้: เขียน docstring สำหรับฟังก์ชันนี้

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

คำตอบของโมเดล:

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

การสร้าง docstring ด้วย 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.
    [...]
    """

การสร้าง docstring ด้วย AI

นี่คือ 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

คำสั่งของผู้ใช้: สร้างไฟล์ README ในรูปแบบ Markdown ที่อธิบาย class SalesAnalyzer และเมธอดต่าง ๆ พร้อมตัวอย่างโค้ดสำหรับวิเคราะห์แนวโน้มยอดขายในช่วงเวลาสุ่ม

คำตอบของโมเดล:

นี่คือร่าง README.md สำหรับ class SalesAnalyzer:

SalesAnalyzer

class SalesAnalyzer ช่วยให้วิเคราะห์ข้อมูลยอดขายรายวันและตรวจสอบว่าแนวโน้มยอดขายกำลังเพิ่มขึ้นหรือลดลง/คงที่ได้อย่างง่ายดาย เหมาะสำหรับธุรกิจหรือบุคคลที่ต้องการภาพรวมยอดขายอย่างรวดเร็ว

การสร้าง commit message จาก code diff

คำสั่งของผู้ใช้: เขียน commit message ที่มีความหมายจาก 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 อัตโนมัติ

กรณีการใช้งานอื่น ๆ

มาฝึกกันเถอะ!

การเขียนโค้ดด้วยความช่วยเหลือของ AI สำหรับนักพัฒนา