Dalam tutorial ini, kita akan belajar membuat komen di Python dengan bantuan contoh.
Video: Komen di Python
Komen adalah penerangan yang membantu pengaturcara memahami maksud dan fungsi program dengan lebih baik.
Mereka tidak diendahkan sepenuhnya oleh jurubahasa Python.
Kelebihan Menggunakan Komen
Menggunakan komen dalam program menjadikan kod kami lebih mudah difahami. Ini menjadikan program lebih mudah dibaca yang membantu kita mengingat mengapa blok kod tertentu ditulis.
Selain itu, komen juga boleh digunakan untuk mengabaikan beberapa kod semasa menguji blok kod yang lain. Ini menawarkan cara mudah untuk mencegah pelaksanaan beberapa baris atau menulis kod pseudo cepat untuk program ini.
Komen Garis Tunggal di Python
Di Python, kami menggunakan simbol hash #untuk menulis komen satu baris.
Contoh 1: Menulis Komen Baris Tunggal
# printing a string print('Hello world')
Pengeluaran
Hai dunia
Di sini, komennya adalah:
# printing a string
Garis ini tidak diendahkan oleh jurubahasa Python.
Semua yang berlaku selepas #itu tidak dihiraukan. Jadi, kita juga boleh menulis program di atas dalam satu baris sebagai:
print('Hello world') #printing a string
Keluaran program ini akan sama seperti dalam Contoh 1 . Jurubahasa mengabaikan semua teks selepasnya #.
Komen Pelbagai Talian di Python
Python tidak menawarkan cara tersendiri untuk menulis komen berbilang baris. Namun, ada cara lain untuk mengatasi masalah ini.
Kita dapat menggunakan #pada setiap baris komen pada beberapa baris.
Contoh 2: Menggunakan pelbagai #
# it is a # multiline # comment
Di sini, setiap baris diperlakukan sebagai satu komen dan semuanya diabaikan.
String Literals untuk Komen pelbagai baris
Walaupun tidak ada cara yang unik untuk menulis komen multiline di Python, kami tahu bahawa jurubahasa Python mengabaikan literal rentetan yang tidak diberikan kepada pemboleh ubah.
Oleh itu, kita boleh menulis komen satu baris sebagai:
#this is a comment 'this is an unassigned string as a comment '
Di sini, kita dapat melihat bahawa baris kedua program adalah rentetan tetapi tidak diberikan kepada pemboleh ubah atau fungsi apa pun. Jadi, jurubahasa mengabaikan tali.
Dengan cara yang serupa, kita dapat menggunakan rentetan multiline (petikan tiga) untuk menulis komen multiline.
Watak petikan boleh menjadi 'atau ".
Contoh 3: Menggunakan String Literals untuk menulis Komen Berbilang baris
''' I am a multiline comment! ''' print("Hello World")
Di sini, rentetan multiline tidak diberikan kepada pemboleh ubah apa pun, jadi ia diabaikan oleh jurubahasa. Walaupun secara teknis bukan komen multiline, ia dapat digunakan sebagai satu.
Dokstring Python
Secara konvensional, petikan tiga yang muncul tepat setelah fungsi, kaedah atau definisi kelas adalah dokumen (rentetan dokumentasi).
Dokumen berkaitan dengan objek dan dapat diakses menggunakan __doc__atribut.
Untuk mengetahui lebih lanjut, lawati dokumentasi Python.
Bagaimana Menulis Komen yang Lebih Baik?
- Gunakan komen untuk menerangkan fungsi yang dilakukan dan bukan perincian khusus mengenai bagaimana fungsi itu berfungsi.
- Cuba keluarkan sebanyak mungkin komen berlebihan. Cuba tulis kod yang dapat menjelaskannya sendiri, dengan menggunakan fungsi nama / pemboleh ubah yang lebih baik.
- Cuba buat komen sesingkat dan ringkas mungkin.
