# Fungsi untuk menghitung total harga belanjaan
def hitung_total(harga_barang, jumlah_barang):
"""
Fungsi ini digunakan untuk menghitung total harga belanjaan berdasarkan harga barang dan jumlah barang.
Parameters:
harga_barang (float): Harga satu barang.
jumlah_barang (int): Jumlah barang yang dibeli.
Returns:
float: Total harga belanjaan.
"""
total = harga_barang * jumlah_barang
return total
4. Hindari Komentar yang Berlebihan
Komentar yang terlalu banyak atau berlebihan dapat membuat kode menjadi berantakan dan sulit dibaca. Gunakan komentar dengan bijak dan hanya tambahkan komentar yang benar-benar diperlukan untuk menjelaskan bagian-bagian penting dari kode. Misalnya, jika sebuah variabel sudah memiliki nama yang menjelaskan fungsinya, tambahan komentar mungkin tidak perlu:
# Inisialisasi variabel total harga belanjaan
total_harga = 0
5. Perbarui Komentar secara Berkala:
Komentar yang tidak diperbarui ketika kode mengalami perubahan dapat menjadi salah informasi dan menyesatkan. Pastikan untuk memperbarui komentar Anda sesuai dengan perubahan yang terjadi pada kode. Misalnya, jika Anda mengubah logika di dalam sebuah fungsi, pastikan untuk memperbarui komentar yang menjelaskan apa yang dilakukan oleh fungsi tersebut:
# Fungsi untuk menghitung total harga belanjaan
def hitung_total(harga_barang, jumlah_barang):
"""
Fungsi ini digunakan untuk menghitung total harga belanjaan berdasarkan harga barang dan jumlah barang.
Parameters:
harga_barang (float): Harga satu barang.
jumlah_barang (int): Jumlah barang yang dibeli.
Returns:
float: Total harga belanjaan.
"""
total = harga_barang * jumlah_barang
# Menghitung diskon jika harga total melebihi 1000
if total > 1000:
total -= total * 0.1
return total
6. Komentar untuk Dokumentasi dan Spesifikasi
Komentar tidak hanya berguna untuk menjelaskan bagian kode yang kompleks, tetapi juga untuk mendokumentasikan fungsionalitas dan spesifikasi dari modul, kelas, atau fungsi yang Anda buat.
