Pada tutorial ini, Anda akan diajarkan tentang cara menambahkan komentar ke dalam kode Anda. Anda akan mempelajari berbagai jenis komentar Python, termasuk komentar blok, komentar satu baris, dan string dokumentasi.
Saat menjalankan program, interpreter Python akan mengabaikan komentar dan hanya menafsirkan kode.
Python menyediakan tiga jenis komentar, yaitu komentar blok, komentar sebaris, dan string dokumentasi.
Komentar blok Python
digunakan untuk menjelaskan kode yang mengikutinya. Biasanya, komentar blok di-indentasi pada tingkat yang sama dengan blok kode yang terkait. Untuk membuat komentar blok, Anda dapat menggunakan tanda pagar (#) diikuti oleh spasi dan teks komentar.
Sebagai contoh:
# menaikkan harga sebesar 5%
price = price * 1.05Komentar sebaris Python
ditempatkan pada baris yang sama dengan pernyataan kode. Mirip dengan komentar blok, komentar sebaris dimulai dengan tanda pagar (#) dan diikuti oleh spasi dan teks komentar.
salary = salary * 1.02 # menaikkan gaji sebesar 2%String dokumentasi (docstring)
adalah string literal yang ditempatkan sebagai baris pertama dalam sebuah blok kode, seperti fungsi. String dokumentasi tidak dianggap sebagai komentar biasa dan dapat diakses pada saat runtime menggunakan atribut __doc__. Biasanya, string dokumentasi digunakan untuk membuat dokumentasi kode secara otomatis. Terdapat dua jenis docstring dalam Python, yaitu docstring satu baris dan docstring multi-baris.
1. Docstring satu baris
cocok dengan satu baris saja dan diapit oleh tiga tanda kutip (“””). Tidak ada baris kosong sebelum atau sesudah docstring satu baris.
Contohnya:
def quicksort():
"""mengurutkan list menggunakan algoritma quicksort"""
...2. Docstring multi-baris
dapat mencakup beberapa baris dan diapit oleh tiga tanda kutip (“””).
Contohnya:
def increase(salary, percentage, rating):
"""menaikkan gaji berdasarkan rating dan persentase
rating 1 - 2 tidak ada kenaikan
rating 3 - 4 kenaikan 5%
rating 4 - 6 kenaikan 10%
"""Python tidak secara langsung mendukung komentar multi-baris, tetapi Anda dapat menggunakan docstring multi-baris sebagai penggantinya. Disarankan untuk membuat komentar Anda jelas, ringkas, dan mudah dipahami untuk menghemat waktu dan usaha bagi Anda dan pengembang lain yang akan membaca kode tersebut di masa depan.
