1. Gunakan Bahasa yang Jelas dan Tertata
Ini berarti bahwa Anda harus menulis komentar Anda dengan bahasa yang mudah dimengerti dan terstruktur dengan baik. Misalnya, jika Anda memiliki fungsi untuk menghitung total harga belanjaan, Anda bisa menambahkan komentar yang menjelaskan apa yang dilakukan oleh fungsi tersebut dengan cara yang jelas:
# 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
2. Jelaskan “Mengapa”, Bukan “Apa”
Fokus pada menjelaskan mengapa suatu tindakan dilakukan dalam kode lebih penting daripada sekadar menjelaskan apa yang dilakukan. Misalnya, jika Anda memiliki sebuah kondisional yang menentukan apakah sebuah barang memiliki diskon atau tidak, Anda bisa menjelaskan mengapa diskon diberikan pada barang tersebut:
if harga_barang > 1000:
# Berikan diskon 10% jika harga barang lebih dari 1000
harga_barang -= harga_barang * 0.1
3. Jaga Konsistensi
Konsistensi dalam gaya dan format penulisan komentar sangat penting untuk memastikan bahwa kode mudah dibaca dan dipahami. Pastikan untuk menggunakan gaya penulisan yang seragam di seluruh kode Anda, seperti penggunaan huruf kapital untuk kata pertama dan penggunaan baris baru setelah komentar. Misalnya:
