Dokümantasyon
Python'da Yazılım Mühendisliği İlkeleri
Adam Spannbauer
Machine Learning Engineer at Eastman
Python'da Dokümantasyon
- Yorumlar
# x sayısını karesini al
- Docstring'ler
"""x sayısını karesini al
:param x: karesi alınacak sayı
:return: x'in karesi
>>> square(2)
4
"""
Yorumlar
# Bu geçerli bir yorumdur
x = 2
y = 3 # Bu da geçerli bir yorumdur
# Beni ancak kaynak kodu incelersen görebilirsin# Merhaba gelecekteki işbirlikçiler!!
Etkili yorumlar
'Ne'yi Yorumlama
# Kişi sayısını 5 olarak tanımla
people = 5
# Kişi sayısını 3 ile çarp
people * 3
'Niçin' Yorumlama
# Partiye 5 kişi katılacak
people = 5
# Kişi başına 3 dilim pizza gerekiyor
people * 3
Docstring'ler
def function(x):
"""Fonksiyonun üst düzey açıklaması
Fonksiyon hakkında ek detaylar
Docstring'ler
def function(x):
"""Fonksiyonun üst düzey açıklaması
Fonksiyon hakkında ek detaylar
:param x: x parametresinin açıklaması
:return: dönüş değerinin açıklaması
Flask paketinde bir docstring'den oluşturulan örnek web sayfası.
Docstring'ler
def function(x):
"""Fonksiyonun üst düzey açıklaması
Fonksiyon hakkında ek detaylar
:param x: x parametresinin açıklaması
:return: dönüş değerinin açıklaması
>>> # Fonksiyon kullanım örneği
Örnek fonksiyon kullanımının beklenen çıktısı
"""
# fonksiyon kodu
Örnek docstring
def square(x):
"""x sayısını karesini al
:param x: karesi alınacak sayı
:return: x'in karesi
>>> square(2)
4
"""
# `x * x`, `x ** 2`'den daha hızlıdır
# referans: https://stackoverflow.com/a/29055266/5731525
return x * x
Örnek docstring çıktısı
help(square)
square(x)
x sayısını karesini al
:param x: karesi alınacak sayı
:return: x'in karesi
>>> square(2)
4
Uygulama Zamanı
Python'da Yazılım Mühendisliği İlkeleri
