Pengeluaran Dokumentasi Fungsi dalam Python

Dalam badan fungsi, anda boleh menulis rentetan, yang menerangkan intipati kerja yang dijalankan. Rentetan sedemikian biasanya dianggap sebagai dokumentasi fungsi. Ia diletakkan dalam tanda petik tunggal dan diletakkan pada baris pertama badan fungsi. Untuk membacanya, anda perlu menggunakan fungsi khas help, yang parameternya diisi dengan nama fungsi.

Katakan kita mempunyai fungsi yang menambah dua nombor. Maklumat tentang ini ditinggalkan dalam rentetan dengan maklumat yang sepadan:

pythondef getSum(num1, num2):
  'fungsi ini menambah dua nombor'
  return num1 + num2

Mari kita panggil help dan ketahui apa yang dikomen dalam getSum:

pythonhelp(getSum)

Selepas kod dilaksanakan, konsol akan memaparkan rentetan dengan nama fungsi dan dokumentasinya:

pythonHelp on function getSum in module __main__:

getSum(num1, num2)
  fungsi ini menambah dua nombor

Dengan menggunakan fungsi help, anda boleh membaca dokumentasi untuk fungsi piawai juga. Mari kita dapatkan maklumat tentang fungsi print:

pythonhelp(print)

Untuk mencetak hanya rentetan dokumentasi dari fungsi, anda perlu menghantar kepada help selepas nama fungsi, konstruksi perkhidmatan .__doc__:

pythonhelp(print.__doc__)