Hampir di seluruh bahasa pemrograman memiliki sintaks komentar, begitu juga dengan python. Komentar sendiri sangat berguna dalam membuat kode program, di antaranya:
- Komentar bisa digunakan sebagai penjelasan kode program yang telah dibuat.
- Komentar berguna agar source code menjadi lebih readable terutama ketika bekerja sebagai proyek kolaborasi.
Di materi sebelumnya kita telah sedikit belajar terkait dengan sintaks dasar untuk komentar di python. Jika diperhatikan dalam materi tersebut kita sudah mengenal cara membuat komentar dalam satu baris kode.
Dalam python, selain bisa membuat komentar dalam satu baris kode, kita bisa juga membuat komentar multi baris atau sering disebut multiline comments. Di materi ini, mari kita pelajari lebih dalam terkait dengan cara membuat komentar di python.
Membuat komentar python
Untuk membuat komentar satu baris, Kamu bisa mengawali dengan simbol #, jadi setiap baris kode yang diawali simbol tersebut dalam satu baris akan dianggap sebagai komentar oleh python. Sehingga apapun tulisan setelahnya tidak akan dieksekusi.
Contoh 1
# Ini adalah komentar
print("Hello Python!")
Contoh 2
print("Hello Python!") # Ini juga komentar
Di contoh 1, tulisan `Ini adalah komentar` tidak akan dieksekusi oleh python karena diawali dengan simbol # tanda komentar. Begitu juga di contoh 2, tulisan `Ini juga komentar` tidak akan dijalankan, tetapi meskipun fungsi print satu baris dengan komentar tersebut, python tetap mengeksekusi fungsi mencetak itu karena berada sebelum simbol #.
Membuat komentar multiline python
Dalam membuat komentar, kadang-kadang kita perlu membuat penjelasan yang panjang (lebih dari satu baris) untuk dokumentasi kode, tentu saja membuat komentar secara baris per baris bisa dilakukan.
Tapi, alih-alih membuat kode menjadi readable, praktek seperti itu justru malah membuat kode jadi tidak enak dibaca. Oleh karena itu, jika memang perlu membuat komentar multi baris, kita bisa menggunakan sintaks string literal berikut """...""", di mana isi penjelasan komentar berada di antara tiga buah petik dua.
String literal yang tidak ditetapkan ke dalam suatu variabel akan diabaikan sehingga tidak akan dieksekusi oleh python.
Contoh 1
"""Ini adalah komentar
multiline di python"""
print("Hello Python!")
Contoh 2
"""
Ini adalah komentar multiline di python,
baris ini tidak akan dijalankan oleh python
"""
print("Hello Python!")