Python docstring

Dokumentasi sangat penting untuk pemrograman apa pun untuk memahami kode dengan mudah. Ini digunakan untuk menjelaskan tujuan penggunaan pernyataan atau fungsi atau kelas atau modul apa pun dalam program. Ini membantu pembuat kode utama mengingat fungsi kode apa pun setelah waktu yang lama, dan juga membantu pembuat kode lain yang ingin mengerjakan proyek yang sama. Pembuat kode menggunakan satu baris komentar untuk menjelaskan bagian tertentu dari fungsi kode secara singkat. String dokumen atau docstring Python digunakan untuk menjelaskan fungsi segmen tertentu dari kode secara detail. Baris docstring harus dimulai dengan huruf kapital dan diakhiri dengan titik. Baris pertama docstring berisi deskripsi singkat tentang dokumentasi secara umum. Baris kedua docstring harus kosong untuk docstring multi-baris besar. Tiga tanda kutip tunggal ('") atau tanda kutip ganda rangkap tiga(""") digunakan untuk mendefinisikan docstring dengan Python. Konten docstring dapat diakses dengan menggunakan __doc__ atribut objek dan menggunakan Tolong() metode. Cara mendeklarasikan dan mengakses docstring dengan Python telah ditunjukkan dalam tutorial ini.

Contoh-1: Mengakses docstring dari suatu fungsi menggunakan __dokter__ atribut

Cara mendeklarasikan dan mengakses docstring dari fungsi kustom telah ditunjukkan dalam skrip berikut:. Skrip berikut menghitung x^tidak di mana x dan n akan diambil dari pengguna. Kekuasaan () fungsi telah didefinisikan dalam skrip untuk melakukan tugas. Di sini, docstring telah didefinisikan untuk fungsi ini. __dokter__ atribut telah digunakan dalam skrip untuk mencetak docstring dengan output.

daya def (x, n):
"Hitung x ke pangkat n
Baca nilai x dan n dari argumen fungsi
dan Hitung dan kembalikan nilai x ke pangkat n."
kembali x**n
# Ambil nilai x
x = int(input('Masukkan nilai x:'))
# Ambil nilai n
n = int(input('Masukkan nilai n:'))
# Cetak nilai pengembalian fungsi
print("%d pangkat %d = %d" %(x, n, pangkat(x, n)))
# Cetak nilai docstring
print("Isi docstring:\n" + power.__dokter__)

Keluaran:

Output berikut akan muncul setelah menjalankan skrip di atas:.

Contoh-2: Mengakses docstring kelas dan metode menggunakan Tolong() metode

Cara mendeklarasikan dan mengakses docstring dokumen dan metode kelas tersebut telah ditunjukkan dalam skrip berikut. Fungsi utama skrip adalah untuk mengurutkan daftar numerik dan membalikkan data daftar. Daftar numerik 8 elemen telah dideklarasikan di kelas, dan docstring telah didefinisikan di awal kelas dengan menggunakan tanda kutip tunggal tiga. Metode sort_list() telah didefinisikan di kelas untuk mencetak data yang diurutkan dari daftar, dan dokumen telah mendefinisikan ini untuk metode ini. daftar_balik() metode didefinisikan untuk mencetak data terbalik daftar, dan docstring juga telah ditentukan untuk metode ini. Tolong() metode telah memanggil tiga kali di akhir skrip untuk mencetak docstring dari daftar_operasi kelas, sort_list() metode, dan daftar_balik() metode.

operasi_daftar kelas:

operasi_daftar kelas:
"
Menyortir dan membalikkan data daftar
Kelas berisi dua metode,
sort_list() metode akan mengurutkan dan mencetak daftar,
sort_reverse() metode akan membalikkan dan mencetak daftar.
"
# Tentukan daftar data numerik
listdata = [23, 67, 23, 6, 45, 3, 90, 11]
def sort_list(sendiri):
"
Cetak nilai daftar setelah menyortir
Fungsi akan mengambil objek daftar data numerik dari argumen,
urutkan nilai daftar menggunakan metode sort()
dan cetak nilai dari daftar yang diurutkan.
"
# Urutkan daftar
diri.daftar data.menyortir()
# Cetak daftar yang diurutkan menggunakan loop
print("Nilai dari daftar yang diurutkan:\n")
untuk nilai dalam diri.daftar data:
cetak(nilai, " ", akhir=")
def reverse_list(sendiri):
"
Cetak nilai daftar setelah membalikkan
Fungsi akan mengambil objek daftar data numerik dari argumen,
membalikkan nilai daftar menggunakan metode reverse()
dan cetak nilai dari daftar terbalik.
"
# Balikkan daftarnya
diri.daftar data.balik()
# Cetak daftar terbalik menggunakan loop
print("Nilai dari daftar yang diurutkan:\n")
untuk nilai dalam diri.daftar data:
cetak(nilai, " ", akhir=")
# Cetak nilai docstring kelas
bantuan (daftar_operasi)
# Buat objek kelas
obj = daftar_operasi()
# Cetak nilai docstring dari metode tertentu
bantuan (obj.sort_list)
# Panggil metode untuk mencetak daftar yang diurutkan
obj.sort_daftar()

Keluaran:

Output berikut akan muncul setelah menjalankan skrip:. Semua docstring skrip telah dicetak untuk yang pertama Tolong() fungsi. Doktrin dari sort_list() metode telah dicetak untuk yang kedua Tolong() fungsi.

Contoh-3: Mengakses docstring dari modul Python bawaan

Dalam contoh sebelumnya, docstring telah digunakan di kelas dan fungsi yang ditentukan pengguna. Setiap modul dan kelas Python bawaan memiliki docstring yang menjelaskan tujuan penggunaan modul atau fungsi tertentu itu. Pembuat kode modul atau fungsi mendefinisikan docstring agar kode dapat dimengerti oleh pengguna. Skrip berikut akan mencetak docstring modul datetime yang telah ditentukan sebelumnya dengan menggunakan: Tolong() fungsi.

# Impor modul waktu-tanggal
waktu impor
# Menampilkan docstring datetime
bantuan (waktu kencan)

Keluaran:

Output berikut akan muncul setelah menjalankan skrip:. Docstring modul datetime menunjukkan dokumentasi rinci untuk membantu orang lain mengetahui fungsi kelas dan metode yang didefinisikan dalam modul ini dengan benar.

Kesimpulan:

Dokumentasi yang tepat sangat penting ketika modul atau fungsi apa pun diimplementasikan untuk tujuan khusus untuk membantu pembuat kode lain menggunakan modul dalam kode mereka untuk melakukan tugas tertentu. Jika dokumentasi tidak didefinisikan dengan benar untuk modul atau fungsi, pengguna lain akan menghadapi masalah dalam menggunakannya. Jadi, setiap pembuat kode harus menggunakan docstring dokumen untuk memberikan informasi terperinci agar yang lain dapat memahami kodenya.