Python'da Fonksiyon Dokümantasyonunu Görüntüleme

Bir fonksiyonun gövdesinde, yapılan işin özünü açıklayan bir dize yazılabilir. Bu tür bir dize genellikle fonksiyonun dokümantasyonu olarak kabul edilir. Tek tırnak içine alınır ve fonksiyon gövdesinin ilk satırına yerleştirilir. Okumak için, parametresine fonksiyonun adının verildiği özel bir help fonksiyonu kullanılmalıdır.

İki sayıyı toplayan bir fonksiyonumuz olduğunu varsayalım. İlgili bilgi ile bir açıklama dizesi eklenmiştir:

def getSum(num1, num2):
	'this function sums two numbers'
	return num1 + num2

Hadi help fonksiyonunu çağıralım ve getSum içinde ne yazılı olduğunu görelim:

help(getSum)

Kod çalıştırıldıktan sonra konsolda, fonksiyonun adı ve dokümantasyonu ile bir dize belirecek:

Help on function getSum in module __main__:

getSum(num1, num2)
	this function sums two numbers

help fonksiyonu kullanılarak standart fonksiyonların dokümantasyonu da okunabilir. Hadi print fonksiyonu hakkında bilgi edinelim:

help(print)

Bir fonksiyondan sadece dokümantasyon dizesini almak için, help fonksiyonuna fonksiyon adından sonra .__doc__ servis yapısı iletilmelidir:

help(print.__doc__)

Parametre olarak bir ay isimleri listesi alan ve bunları büyük harfle yazdıran bir fonksiyon oluşturun. Fonksiyonun işleyişini dokümantasyonda açıklayın ve bunu konsola yazdırın.

sum fonksiyonu hakkındaki tüm dokümantasyonu yazdırın.

len fonksiyonu hakkında sadece dokümantasyon dizesini yazdırın.