Yapay Zeka ile Kod Belgeleme

Geliştiriciler için Yapay Zeka Destekli Kodlama

Francesca Donadoni

AI Curriculum Manager, DataCamp

Yapay Zeka Destekli Docstring Oluşturma

Kullanıcı isteği: Bu fonksiyon için bir docstring yazın

   def sales_trend(self):
       ...        
       if increasing > decreasing:
           return "Artan eğilim"
       else:
           return "Azalan veya sabit eğilim"

Modelin yanıtı:

 def sales_trend(self):
     """Satış verilerini analiz ederek genel eğilimi belirleyin"""
     [...]

Yapay Zeka Destekli Docstring Oluşturma

Kullanıcı isteği: Bu fonksiyon için bir docstring oluşturun ve şunları ekleyin:
- Fonksiyonun ne yaptığının basit bir açıklaması.
- Her parametrenin açıklaması ve türü.
- Dönüş değerinin açıklaması ve türü.
Modelin yanıtı:

İşte fonksiyonunuz için kullanabileceğiniz tam bir docstring:

def sales_trend(self):
    """
    Satış verilerini analiz ederek artan veya azalan/sabit bir eğilim olup olmadığını belirleyin.
    [...]
    """

Yapay Zeka Destekli Docstring Oluşturma

İşte fonksiyonunuz için kullanabileceğiniz tam bir docstring:

def sales_trend(self):
    """
    Satış verilerini analiz ederek artan veya azalan/sabit bir eğilim olup olmadığını belirleyin.
    Parametreler

    ----------
    self : nesne
        Günlük satış değerlerini kronolojik sırayla temsil eden `daily_sales` (int veya float listesi) özelliğini içeren bir nesne.
    [...]
    """

Belgeleme Tarzlarına Uyum

Kodları README'lerde Özetleme

Kullanıcı isteği: SalesAnalyzer sınıfını ve yöntemlerini açıklayan bir README dosyası oluşturun. Kullanıcıların rastgele bir dönem boyunca satış eğilimini analiz etmelerine yardımcı olacak bir örnek kod parçası ekleyin.

Modelin yanıtı:

İşte SalesAnalyzer sınıfınız için düzenlenmiş bir README.md taslağı:

SalesAnalyzer

SalesAnalyzer sınıfı, günlük satış verilerini analiz etmenin ve satış eğiliminin genel olarak artıp artmadığını veya azalıp sabit kaldığını tespit etmenin basit bir yolunu sunar. Bu araç, zaman içinde satış performanslarının hızlı ve üst düzey bir görünümünü isteyen işletmeler veya bireyler için faydalı olabilir.

Kod Farklarından Commit Mesajları

Kullanıcı isteği: Bu git farkına göre anlamlı bir commit mesajı yazın:

(base) datacamp@test:~/datacamp/docstring-generation$ git diff
+
+        Raises:
+            ValueError: Eğer daily_sales sayısal olmayan değerler içeriyorsa.
         """
-        return sum(self.daily_sales)
+        if not all(isinstance(sale, (int, float)) for sale in self.daily_sales):
+            raise ValueError("Tüm satış rakamları sayısal olmalıdır.")
+        return sum(sale for sale in self.daily_sales)

Sürüm Notlarını Otomatikleştirme

Diğer Kullanım Alanları

Haydi pratik yapalım!

Geliştiriciler için Yapay Zeka Destekli Kodlama