Dokümantasyon Dizgileri

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

Belge dizesi veya docstring, çoğunlukla bir modül, işlev, sınıf veya metot tanımındaki ilk ifade olarak bulunur.

Docstring'i dizeyi """ veya ''' ile çevreleyerek bildirin; örneğin:

def complex(real=0.0, imag=0.0):
	"""
	Karmaşık bir sayı oluştur.
	
		Parametreler:
			real (float) -- gerçek kısım (varsayılan 0.0)
			imag (float) -- sanal kısım (varsayılan 0.0)
	"""
    if imag == 0.0 and real == 0.0:
        return complex_zero
    ...

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

Belge gövdesinin girintisine ve """ işaretine dikkat edin.

Docstring'i bu şekilde kullandıktan sonra belgeyi almak için __doc__ özelliğini kullanabilirsiniz:

complex.__doc__

Aşağıdaki çıktıyı verir:

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 açıklaması içeren bir fonksiyon veriliyor.

Görevin, bunu geçerli bir docstring ile değiştirmek ve doğru docstring biçimlendirmesini elde etmek için test senaryosunu kontrol etmektir!

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__)