Docstring
- Python kursu
- Başlangıç
- Ders 73/116
- 3 dk
"""...""" 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 + bDocstring, 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 / bBu 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.
Başlangıç kodu
# square fonksiyonunu tanımlaÖrnek çözüm
def square(n):
"""n'nin karesini dondur."""
return n * n
result = square(5)
print(result)Beklenen çıktı
25
Soru ve cevaplar
Dersin sorularını cevaplarıyla birlikte inceleyebilirsin. Kendini denemek istersen dersi interaktif olarak çöz.
1 Docstring nereye yazılır?
- Fonksiyon adından önce
- Fonksiyon çağrısından sonra
- Fonksiyon gövdesinin ilk satırına Doğru cevap
- return ifadesinden sonra
Açıklama: Docstring gövdenin ilk satırına yazılır.
2 Docstring'i tamamla
def add(a, b):
____Iki sayiyi topla."""
return a + bdef add(a, b):
"""Iki sayiyi topla."""
return a + bAçıklama: Üç tırnakla başlayan docstring gövdeyi açıklar.
3 Docstring parçalarını eşleştir
| Kavram | Anlamı |
|---|---|
""" |
Üç tırnak |
help() |
Docstring gösterir |
__doc__ |
Docstring özelliği |
ilk satır |
Docstring konumu |