Mendokumentasikan kode dengan AI

Pengembangan Kode dengan Bantuan AI untuk Developer

Francesca Donadoni

AI Curriculum Manager, DataCamp

Pembuatan docstring bertenaga AI

Permintaan pengguna: Tulis docstring untuk fungsi ini

   def sales_trend(self):
       ...        
       jika meningkat > menurun:
           return "Tren meningkat"
       else:
           return "Tren menurun atau stabil"

Respon model:

 def sales_trend(self):
     """Analisis data penjualan untuk menentukan tren keseluruhan"""
     [...]

Pembuatan docstring bertenaga AI

Permintaan pengguna: Buat docstring untuk fungsi ini yang mencakup:
- Penjelasan sederhana tentang apa yang dilakukan fungsi.
- Deskripsi setiap parameter dan jenisnya.
- Deskripsi nilai pengembalian dan jenisnya.
Respon model:

Berikut adalah docstring lengkap yang dapat Anda gunakan untuk fungsi Anda:

def sales_trend(self):
    """
    Analisis data penjualan untuk menentukan apakah ada tren meningkat 
    atau tren menurun/stabil dari waktu ke waktu.
    [...]
    """

Pembuatan docstring bertenaga AI

Berikut adalah docstring lengkap yang dapat Anda gunakan untuk fungsi Anda:

def sales_trend(self):
    """
    Analisis data penjualan untuk menentukan apakah ada tren meningkat 
    atau tren menurun/stabil dari waktu ke waktu.

    Parameter
    ----------
    self : objek
        Objek yang berisi atribut `daily_sales` (daftar int atau float),
        yang mewakili nilai penjualan harian dalam urutan kronologis.
    [...]
    """

Menyesuaikan gaya dokumentasi

Merangkum kode ke dalam README

Permintaan pengguna: Buat file README dalam Markdown yang menjelaskan kelas SalesAnalyzer dan metodenya. Sertakan contoh kode untuk membantu pengguna menganalisis tren penjualan selama periode acak.

Respon model:

Berikut adalah draft README.md yang telah diperbaiki untuk kelas SalesAnalyzer Anda:

SalesAnalyzer

Kelas SalesAnalyzer menyediakan cara sederhana untuk menganalisis data penjualan harian dan mendeteksi apakah tren penjualan umumnya meningkat atau menurun/stabil. Alat ini berguna bagi bisnis atau individu yang menginginkan gambaran umum cepat tentang kinerja penjualan mereka dari waktu ke waktu.

Pesan komit dari perbedaan kode

Permintaan pengguna: Tulis pesan komit yang bermakna berdasarkan perbedaan git ini:

(base) datacamp@test:~/datacamp/docstring-generation$ git diff
+
+        Raises:
+            ValueError: Jika daily_sales mengandung nilai non-numerik.
         """
-        return sum(self.daily_sales)
+        jika tidak semua(isinstance(sale, (int, float)) untuk sale dalam self.daily_sales):
+            raise ValueError("Semua angka penjualan harus numerik.")
+        return sum(sale untuk sale dalam self.daily_sales)

Mengotomatisasi catatan rilis

Kasus penggunaan lainnya

Ayo berlatih!

Pengembangan Kode dengan Bantuan AI untuk Developer