Memahami Komentar Python (Python Comments): Pentingnya dan Cara Penggunaannya

ViaByte.Net

Komentar Python
'''
Ini adalah contoh komentar multi-baris.
Komentar ini bisa memiliki beberapa baris.
Komentar ini sangat berguna untuk menjelaskan
bagian-bagian kompleks dari kode.
'''

Contoh Penggunaan Komentar dalam Kode Python

Mari kita lihat contoh sederhana penggunaan komentar dalam kode Python:

# Program ini akan menghitung jumlah angka dalam sebuah list

def hitung_jumlah(angka):
    """
    Fungsi ini menghitung jumlah semua angka dalam sebuah list.

    Parameters:
    angka (list): List berisi angka-angka yang akan dijumlahkan.

    Returns:
    int: Jumlah dari semua angka dalam list.
    """
    total = 0
    for num in angka:
        total += num
    return total

# Contoh penggunaan fungsi hitung_jumlah
angka = [1, 2, 3, 4, 5]
jumlah = hitung_jumlah(angka)
print("Jumlah angka dalam list:", jumlah)

Dalam contoh di atas, komentar digunakan untuk menjelaskan tujuan dari program, fungsi, parameter, dan bagian-bagian kritis dari kode.

Praktik Terbaik dalam Menulis Komentar Python

Untuk memastikan komentar Anda efektif dan membantu, berikut adalah beberapa praktik terbaik dalam menulis komentar Python:

Bagikan:

Tinggalkan komentar