Menampilkan Dokumentasi Fungsi di Python

Dalam tubuh fungsi, Anda dapat menuliskan string yang menjelaskan inti dari pekerjaan yang dilakukan. String seperti itu dianggap sebagai dokumentasi fungsi. String tersebut diapit oleh tanda kutip tunggal dan ditempatkan di baris pertama tubuh fungsi. Untuk membacanya, Anda perlu menggunakan fungsi khusus help, yang parameternya diisi dengan nama fungsi.

Misalkan kita memiliki fungsi yang menjumlahkan dua angka. Informasi yang sesuai telah ditinggalkan dalam string dokumentasi:

def getSum(num1, num2):
	'fungsi ini menjumlahkan dua angka'
	return num1 + num2

Mari kita panggil help dan cari tahu apa yang dikomentari dalam getSum:

help(getSum)

Setelah kode dijalankan, di konsol akan muncul string dengan nama fungsi dan dokumentasinya:

Help on function getSum in module __main__:

getSum(num1, num2)
	fungsi ini menjumlahkan dua angka

Dengan fungsi help, Anda juga dapat membaca dokumentasi fungsi standar. Mari kita cari informasi tentang fungsi print:

help(print)

Untuk hanya menampilkan string dokumentasi dari fungsi, Anda perlu meneruskan konstruksi layanan .__doc__ setelah nama fungsi ke dalam help:

help(print.__doc__)

Buatlah fungsi yang akan menerima daftar nama bulan sebagai parameternya dan menampilkannya dengan huruf kapital. Jelaskan inti pekerjaan fungsi dalam dokumentasi dan tampilkan di konsol.

Tampilkan semua dokumentasi tentang fungsi sum.

Tampilkan hanya string dokumentasi tentang fungsi len.