Karena kita sudah tahu cara menulis komentar multiline, kita dapat menggunakan tanda kutip tunggal tiga atau tanda kutip ganda tiga. Kami menggunakan string dokumentasi ketika kami ingin menggambarkan fungsi kami sehingga kami bisa mendapatkan dokumentasi saat kami membutuhkannya. Beberapa IDE memberi Anda dokumentasi dengan hanya mengarahkan kursor ke nama dan beberapa menyoroti kata kunci tertentu. Tetapi kenyataannya adalah bahwa docstrings di NumPy jauh lebih fleksibel daripada dalam bahasa lain. Docstring adalah literal string yang muncul di awal definisi fungsi. Kami harus memberikan nilai spesifik saat menggunakan docstrings dalam kasus fungsi, kelas, dll.
Saat menggunakan docstrings dengan fungsi, kita harus meneruskan argumen. Saat menggunakannya dengan kelas, kami meneruskan atribut dan metode. Dalam kasus Modul, kita harus menyediakan daftar kelas dan fungsi. Dalam hal paket, kami melewati daftar modul dengan fungsionalitas. Jadi pada dasarnya, tujuan dari docstring adalah, seperti yang dijelaskan oleh namanya, untuk membantu dokumentasi kode kita. Kami melakukan dokumentasi sehingga jika seseorang menggunakan kode kami di masa depan, dia akan dapat memahami kode kami dan logika di balik kode kami dengan bantuan docstring. Fungsi bawaan juga memiliki docstring di dalamnya; kita dapat menggunakan fungsi help() untuk melihat docstring dari fungsi bawaan.
Ada beberapa perbedaan antara komentar dan docstrings. Komentar diabaikan oleh interpreter tetapi docstrings tidak diabaikan oleh interpreter. Memori dialokasikan untuk docstrings. Komentar adalah deskripsi kode tetapi di sisi lain, docstrings memberi tahu kami tujuan kode.
Sintaksis:
Sintaks untuk menulis docstrings di NumPy adalah:
'''Pesan Dokstring'''
Atau
'''Pesan docstring'''
Harap dicatat bahwa docstring bukan fungsi atau metode, sehingga tidak memiliki sintaks yang tepat. Satu-satunya hal yang perlu diperhatikan di sini adalah kita memulai docstring dengan tiga tanda kutip tunggal atau tiga tanda kutip ganda. Kami menulis deskripsi kode kami dan mengakhirinya lagi dengan tiga tanda kutip tunggal atau tiga tanda kutip ganda di akhir. Tidak ada hal wajib untuk ditulis untuk docstrings. Anda hanya perlu meletakkan tiga tanda kutip tunggal atau ganda sebelum dan sesudah deskripsi string Anda.
Contoh 1:
Untuk memahami docstrings dengan cara yang lebih baik, mari kita lakukan sebuah contoh. Dalam contoh ini, setelah menyertakan library NumPy, kita cukup mendeklarasikan variabel “a” dan variabel lain “b”. Setelah itu, kami membuat docstring kami yang mengatakan 'Mari kita tambahkan variabel 'a' dan 'b''. Dalam kasus kami, ini adalah contoh yang mudah tetapi jika kode kami rumit, ini sangat membantu pembuat kode dalam memahami kode. Setelah itu, kita jumlahkan variabel “a” dan “b” dan simpan hasil outputnya ke variabel lain yaitu “c”. Akhirnya, kami mencetak nilai variabel 'c'. Sekarang, kita mengeksekusi kode kita.
impor numpy sebagai misalnyasebuah = 1
b = dua
'''Mari kita tambahkan variabel a dan b'''
c = a+b
mencetak ( c )
Ini adalah output kami dari potongan kode yang diberikan. Kita dapat melihat bahwa sistem tidak memberikan kesalahan apapun tentang sintaks yang salah atau apapun untuk baris7 dari kode kita. Juga, sistem belum mencetak docstring kami. Sebagai gantinya, itu hanya mencetak output dari variabel kami 'c' di mana kami memberi tahu sistem kami untuk mencetak. Ini menunjukkan bagaimana docstrings bekerja. Lain kali, ketika pembuat kode baru mencoba mengerjakan kode kita, dia akan mengerti apa yang kita lakukan dengan bantuan docstring. Tapi itu tidak akan dicetak sebagai output sehingga pengguna kode tidak akan terganggu olehnya.
Contoh 2:
Sekarang, kami melakukan contoh kompleks untuk memahami cara kerja docstring. Pertama, kami menyertakan pustaka NumPy dan kemudian menulis string dokumen di mana kami menjelaskan baris kode berikutnya di mana kami menjelaskan inisialisasi array. Kami juga menambahkan docstrings di bagian lain dari kode. Sekarang, jika kita membagikan kode ini dengan pengembang Python baru tanpa menambahkan docstrings, entah bagaimana akan sulit baginya untuk mengetahui cara kerja dan tujuan kode ini. Dia harus mencari dulu tentang fungsi yang kita gunakan. Tetapi jika kita menambahkan docstring ke kode kita, akan mudah bagi pengembang lain untuk memahami kode tersebut tanpa mempelajari lebih lanjut tentang fungsinya. Kami tidak dibatasi untuk menambahkan komentar ke beberapa batasan; komentar dapat berupa satu atau lebih dari satu baris. Itu juga dapat ditambahkan lebih dari satu kali dalam sebuah kode. Kemudian, impor NumPy sebagai np.
'''Membuat variabel yang akan kita lewati array ukuran 1x6'''Himpunan = misalnya Himpunan ( [ sebelas , 22 , 33 , 44 , 55 , 66 ] )
'''menetapkan array ke fungsi tofile() untuk membiarkannya disimpan dalam file bernama arr'''
Himpunan . tofile ( 'arr.bin' )
'''tampilkan file menggunakan fungsi fromfile'''
mencetak ( misalnya dari file ( 'arr.bin' , tipe d = ke dalam ) )
Seperti yang ditunjukkan dalam cuplikan berikut, docstrings tidak ditampilkan di output yang berarti tidak memengaruhi output atau kompilasi kode. Docstrings diabaikan selama proses kompilasi.
Kesimpulan
Dalam panduan ini, kami belajar tentang docstrings di NumPy. Kami membandingkan docstrings dengan komentar dan menjelaskan perbedaan di antara keduanya. Kami mempelajari sintaks docstrings dan cara menulis docstrings dalam kode kami. Selanjutnya, kami juga mencoba menjelaskan apa itu docstrings di NumPy dan bagaimana cara kerjanya dengan bantuan contoh. Akhirnya, kami mengatakan bahwa mereka sangat penting untuk pembuat kode. Kami tidak akan mengulangi pentingnya docstrings di NumPy. Kami hanya akan mengatakan bahwa Anda harus menggunakan docstrings dalam kode Anda. Di NumPy, gaya penulisan docstrings adalah yang paling populer. Ini banyak digunakan dalam komunitas pemrograman untuk saling memberi tahu tentang cara kerja dan fungsionalitas kode mereka. Panduan ini akan membantu Anda memulai dengan docstrings NumPy. Kami mencoba untuk menutupi sebagian besar dari apa yang Anda perlukan menggunakan docstrings di NumPy.