Dalam tutorial ini, kita akan belajar membuat komentar dengan Python dengan bantuan contoh.
Video: Komentar dengan Python
Komentar adalah deskripsi yang membantu pemrogram lebih memahami maksud dan fungsionalitas program.
Mereka sepenuhnya diabaikan oleh interpreter Python.
Keuntungan Menggunakan Komentar
Menggunakan komentar dalam program membuat kode kami lebih mudah dipahami. Itu membuat program lebih mudah dibaca yang membantu kita mengingat mengapa blok kode tertentu ditulis.
Selain itu, komentar juga dapat digunakan untuk mengabaikan beberapa kode saat menguji blok kode lainnya. Ini menawarkan cara sederhana untuk mencegah eksekusi beberapa baris atau menulis kode pseudo cepat untuk program.
Komentar Baris Tunggal dengan Python
Di Python, kami menggunakan simbol hash #untuk menulis komentar satu baris.
Contoh 1: Menulis Komentar Satu Baris
# printing a string print('Hello world')
Keluaran
Halo Dunia
Di sini, komentarnya adalah:
# printing a string
Baris ini diabaikan oleh interpreter Python.
Segala sesuatu yang muncul setelahnya #diabaikan. Jadi, kita juga bisa menulis program di atas dalam satu baris sebagai:
print('Hello world') #printing a string
Output dari program ini akan sama seperti pada Contoh 1 . Penerjemah mengabaikan semua teks setelahnya #.
Komentar Multi-Baris dengan Python
Python tidak menawarkan cara terpisah untuk menulis komentar multiline. Namun, ada cara lain untuk mengatasi masalah ini.
Kita dapat menggunakan #di awal setiap baris komentar di beberapa baris.
Contoh 2: Menggunakan beberapa #
# it is a # multiline # comment
Di sini, setiap baris diperlakukan sebagai satu komentar dan semuanya diabaikan.
String Literals untuk Komentar Multi-baris
Meskipun tidak ada cara unik untuk menulis komentar multiline dengan Python, kita tahu bahwa interpreter Python mengabaikan literal string yang tidak ditetapkan ke variabel.
Jadi, kami bahkan dapat menulis komentar satu baris sebagai:
#this is a comment 'this is an unassigned string as a comment '
Di sini, kita dapat melihat bahwa baris kedua dari program adalah string tetapi tidak ditugaskan ke variabel atau fungsi apa pun. Jadi, interpreter mengabaikan string tersebut.
Dengan cara yang sama, kita dapat menggunakan string multiline (tanda kutip tiga) untuk menulis komentar multiline.
Karakter kutipan dapat berupa 'atau ".
Contoh 3: Menggunakan String Literals untuk menulis Komentar Banyak Baris
''' I am a multiline comment! ''' print("Hello World")
Di sini, string multiline tidak ditetapkan ke variabel apa pun, sehingga diabaikan oleh interpreter. Meskipun secara teknis bukan merupakan komentar multiline, namun dapat digunakan sebagai salah satu.
Docstring Python
Sesuai kesepakatan, tanda kutip tiga yang muncul tepat setelah fungsi, metode, atau definisi kelas adalah docstrings (string dokumentasi).
Docstring berhubungan dengan objek dan dapat diakses menggunakan __doc__atribut.
Untuk mempelajari lebih lanjut, kunjungi docstrings Python.
Bagaimana Menulis Komentar yang Lebih Baik?
- Gunakan komentar untuk mendeskripsikan apa yang dilakukan suatu fungsi dan bukan detail spesifik tentang bagaimana fungsi tersebut melakukannya.
- Cobalah untuk menghapus komentar yang berlebihan sebanyak mungkin. Cobalah menulis kode yang dapat menjelaskan dirinya sendiri, menggunakan pilihan nama fungsi / variabel yang lebih baik.
- Cobalah untuk membuat komentar sesingkat dan sesingkat mungkin.
