Dokümantasyon Dizgileri

Coddy'nin Clean Code - Python ile daha iyi kod yazın kursunda ders 8 / 28.

Doküman Dizisi veya Docstring, çoğunlukla bir modül, fonksiyon, sınıf veya metot tanımındaki ilk ifade olarak yer alır.

Docstring'i, dizeyi örneğin """ veya ''' ile sarmalayarak bildirin,

def complex(real=0.0, imag=0.0):
	"""
	Form a complex number.
	
		Parameters:
			real (float) -- the real part (default 0.0)
			imag (float) -- the imaginary part (default 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

complex(real, imag) fonksiyonunu nasıl belgelediğine bir göz atın.

Doküman gövdesinin ve """ işaretinin girintisine dikkat edin

Bu şekilde docstring kullandıktan sonra, dokümantasyonu almak için __doc__ özelliğini kullanabilirsiniz,

complex.__doc__

Aşağıdaki çıktıyı verecektir,

Form a complex number.
	
	Parameters:
		real (float) -- the real part (default 0.0)
		imag (float) -- the imaginary part (default 0.0)

Görev

Kolay

Size docstring yerine blok yorumu içeren bir fonksiyon veriliyor.

Göreviniz bunu geçerli bir docstring ile değiştirmektir, docstring için doğru biçimlendirmeyi elde etmek için test durumunu kontrol edin!

Kendin dene

def sum_binary(a, b):
    # Calculate sum of two integers in binary formmated string
    # Parameters:
    # a (int) -- Integer number
    # b (int) -- Another integer number
    # Returns:
    # binary_sum (str) -- The sum of a and b in binary format
    sum = a + b
    binary_sum = bin(sum)
    return str(binary_sum)[1:] # Final formmating

print(sum_binary.__doc__)