Memandangkan kami sudah tahu cara menulis komen berbilang baris, kami mungkin menggunakan petikan tunggal tiga kali ganda atau petikan berganda ganda tiga. Kami menggunakan rentetan dokumentasi apabila kami ingin menerangkan fungsi kami supaya kami boleh mendapatkan dokumentasi apabila kami memerlukannya. Sesetengah IDE memberi anda dokumentasi dengan hanya melayang di atas nama dan beberapa menyerlahkan kata kunci tertentu. Tetapi hakikatnya ialah docstrings dalam NumPy adalah jauh lebih fleksibel daripada dalam bahasa lain. Docstring ialah rentetan literal yang berlaku pada permulaan definisi fungsi. Kami perlu menyediakan nilai khusus semasa menggunakan docstrings dalam kes fungsi, kelas, dsb.
Apabila menggunakan docstrings dengan fungsi, kita perlu lulus hujah. Apabila menggunakannya dengan kelas, kami lulus atribut dan kaedah. Dalam kes Modul, kami perlu menyediakan senarai kelas dan fungsi. Dalam kes pakej, kami lulus senarai modul dengan fungsi. Jadi pada asasnya, tujuan docstring adalah, seperti namanya, bahawa ia membantu dengan dokumentasi kod kami. Kami melakukan dokumentasi supaya jika seseorang menggunakan kod kami pada masa hadapan, dia akan dapat memahami kod kami dan logik di sebalik kod kami dengan bantuan docstring. Fungsi terbina dalam juga mempunyai docstrings di dalamnya; kita boleh menggunakan fungsi help() untuk melihat docstring fungsi terbina dalam.
Terdapat sedikit perbezaan antara ulasan dan docstrings. Komen diabaikan oleh penterjemah tetapi docstrings tidak diabaikan oleh penterjemah. Memori diperuntukkan untuk docstrings. Komen ialah perihalan kod tetapi sebaliknya, docstrings memberitahu kami tujuan kod.
Sintaks:
Sintaks untuk menulis docstrings dalam NumPy ialah:
'''Mesej docstring'''
Ataupun
'''Mesej docstring'''
Sila ambil perhatian bahawa docstring bukan fungsi atau kaedah, jadi ia tidak mempunyai sintaks yang betul. Satu-satunya perkara yang perlu diperhatikan di sini ialah kita memulakan docstring dengan tiga petikan tunggal atau tiga petikan berganda. Kami menulis perihalan kod kami dan mengakhirinya semula dengan tiga petikan tunggal atau tiga petikan berganda pada penghujungnya. Tiada perkara wajib untuk ditulis untuk docstrings. Anda hanya perlu meletakkan tiga petikan tunggal atau berganda sebelum dan selepas penerangan rentetan anda.
Contoh 1:
Untuk memahami docstrings dengan cara yang lebih baik, mari kita lakukan contoh. Dalam contoh ini, selepas memasukkan perpustakaan NumPy, kami hanya mengisytiharkan pembolehubah 'a' dan pembolehubah lain 'b'. Selepas itu, kami mencipta docstring kami yang mengatakan 'Mari kami menambah pembolehubah 'a' dan 'b''. Dalam kes kami, ini adalah contoh yang mudah tetapi jika kod kami adalah kompleks, ini banyak membantu pengkod dalam memahami kod tersebut. Selepas itu, kami merumuskan pembolehubah 'a' dan 'b' dan menyimpan hasil keluarannya dalam pembolehubah lain iaitu 'c'. Akhir sekali, kami mencetak nilai pembolehubah 'c'. Sekarang, kami melaksanakan kod kami.
import numpy sebagai cth.a = 1
b = dua
'''Mari tambah pembolehubah a dan b'''
c = a+b
cetak ( c )
Ini adalah output kami daripada sekeping kod yang diberikan. Kami dapat melihat bahawa sistem tidak memberikan sebarang ralat tentang sintaks yang salah atau apa-apa untuk baris7 kod kami. Selain itu, sistem belum mencetak docstring kami. Sebaliknya, ia hanya mencetak output pembolehubah 'c' kami yang mana kami memberitahu sistem kami untuk mencetak. Ini menunjukkan cara docstrings berfungsi. Lain kali, apabila pengekod baharu cuba mengusahakan kod kami, dia akan memahami apa yang kami lakukan dengan bantuan docstring kami. Tetapi ia tidak akan dicetak sebagai output supaya pengguna kod tidak akan diganggu olehnya.
Contoh 2:
Sekarang, kami melakukan contoh yang kompleks untuk memahami kerja docstring. Mula-mula, kami memasukkan perpustakaan NumPy dan kemudian menulis rentetan dokumen di mana kami menerangkan baris kod seterusnya di mana kami menerangkan permulaan tatasusunan. Kami juga menambah docstrings di bahagian lain kod. Sekarang, jika kita berkongsi kod ini dengan mana-mana pembangun Python baharu tanpa menambah docstrings, entah bagaimana sukar baginya untuk mengetahui fungsi dan tujuan kod ini. Dia kena cari dulu tentang fungsi yang kita guna. Tetapi jika kami menambah docstring pada kod kami, pembangun lain akan mudah memahami kod tanpa mengkaji lebih lanjut tentang fungsi. Kami tidak terhad untuk menambah ulasan pada beberapa had; komen boleh terdiri daripada satu atau lebih daripada satu baris. Ia juga boleh ditambah lebih daripada sekali dalam kod. Kemudian, import NumPy sebagai np.
'''Mencipta pembolehubah yang mana kita akan lulus tatasusunan saiz 1x6'''tatasusunan = cth. tatasusunan ( [ sebelas , 22 , 33 , 44 , 55 , 66 ] )
'''menyerahkan tatasusunan kepada fungsi tofile() untuk membiarkannya disimpan dalam fail bernama arr'''
tatasusunan . tofile ( 'arr.bin' )
'''paparkan fail menggunakan fungsi fromfile'''
cetak ( cth. fromfile ( 'arr.bin' , dtype = int ) )
Seperti yang ditunjukkan dalam coretan berikut, docstrings tidak dipaparkan dalam output yang bermaksud bahawa ia tidak menjejaskan output atau kompilasi kod. Docstrings diabaikan semasa proses penyusunan.
Kesimpulan
Dalam panduan ini, kami mempelajari tentang docstrings dalam NumPy. Kami membandingkan docstrings dengan ulasan dan menerangkan perbezaan antara kedua-duanya. Kami mempelajari sintaks docstrings dan cara menulis docstrings dalam kod kami. Selain itu, kami juga cuba menerangkan apakah docstrings dalam NumPy dan cara ia berfungsi dengan bantuan contoh. Akhirnya, kami menyatakan bahawa mereka adalah penting untuk pengkod. Kami tidak akan mengulangi kepentingan docstrings dalam NumPy. Kami hanya akan mengatakan bahawa anda harus menggunakan docstrings dalam kod anda. Dalam NumPy, gaya penulisan docstrings adalah yang paling popular. Ia digunakan secara meluas dalam komuniti pengaturcaraan untuk memberitahu satu sama lain tentang kerja dan kefungsian kod mereka. Panduan ini akan membantu anda bermula dengan docstrings NumPy. Kami cuba merangkumi kebanyakan perkara yang anda perlukan menggunakan docstrings dalam NumPy.