Docstring

"""...""" ile fonksiyon belgelerini öğrenirsin.

Docstring

Docstring (belge dizesi), fonksiyonun ne yaptığını anlatan üç tırnaklı bir dizedir. Fonksiyon gövdesinin ilk satırına yazılır:

def add(a, b):
    """Iki sayiyi topla ve dondur."""
    return a + b

Docstring, help(add) veya add.__doc__ ile goruntulenebilir. Bu, fonksiyonun kullanımını açıklar ve takım çalışmasını kolaylaştırır.

Docstring gelenekleri

Iyi bir docstring, fonksiyonun ne yaptığını, parametreleri ve dönüş değerini açıklar:

def divide(a, b):
    """a'yi b'ye bol.

    Parametreler:
        a: bolunen
        b: bolen
    Donus:
        bölüm (float)
    """
    return a / b

Bu geliştiricilere fonksiyonu doğru kullanma sansi verir. IDE'ler docstring'i ipucu olarak gösterir.

Uygulama Docstring'li fonksiyon yaz

square adında bir fonksiyon tanımla; parametre n alsın. Gövdenin ilk satırına """n'nin karesini dondur.""" docstring'ini koy. return n * n ile değeri döndür. result değişkenine square(5) ata. Sonra print(result) yazdır.

Örnek çözümü göster

def square(n):
    """n'nin karesini dondur."""
    return n * n
result = square(5)
print(result)

Kendini test et

Docstring nereye yazılır?
- Fonksiyon adından önce
- Fonksiyon çağrısından sonra
- Fonksiyon gövdesinin ilk satırına
- return ifadesinden sonra
Cevabı göster

Fonksiyon gövdesinin ilk satırına — Docstring gövdenin ilk satırına yazılır.

Docstring'i tamamla

def add(a, b):
    ____Iki sayiyi topla."""
    return a + b

Cevabı göster

def add(a, b):
    """Iki sayiyi topla."""
    return a + b

Docstring parçalarını eşleştir

"""

Üç tırnak
help()

Docstring gösterir
__doc__

Docstring özelliği
ilk satır

Docstring konumu

Sıradaki ders: Varsayılan parametre

Deneyiminizi Geliştiriyoruz

Çerez Tercihleri

Kesinlikle Gerekli Çerezler

Analitik Çerezler