string Dokumentasi
Pelajaran 8 dari 28 dalam kursus Clean Code: Menulis kode yang lebih baik dengan Python di Coddy.
String dokumentasi atau docstring biasanya muncul sebagai pernyataan pertama dalam definisi module, fungsi, class, atau method.
Nyatakan docstring dengan mengapit string menggunakan """ atau ''', misalnya,
def complex(real=0.0, imag=0.0):
"""
Buat bilangan kompleks.
Parameters:
real (float): bagian real (nilai bawaan 0.0)
imag (float): bagian imajiner (nilai bawaan 0.0)
"""
if imag == 0.0 and real == 0.0:
return complex_zero
...perhatikan cara dokumentasi ini menjelaskan fungsi complex(real, imag).
Perhatikan indentasi isi dokumentasi dan
"""
Setelah menggunakan docstring seperti ini, kamu bisa menggunakan property __doc__ untuk mendapatkan dokumentasinya,
complex.__doc__Akan menghasilkan keluaran berikut,
Form a complex number.
Parameters:
real (float) -- the real part (default 0.0)
imag (float) -- the imaginary part (default 0.0)
Tantangan
MudahKamu diberi fungsi dengan komentar blok, bukan docstring.
Tugasmu adalah menggantinya dengan docstring yang valid. Periksa kasus uji untuk mendapatkan pemformatan docstring yang tepat!
Coba sendiri
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__)Semua pelajaran di Clean Code: Menulis kode yang lebih baik dengan Python
Latihan sendiri: Compiler Python online