Macam-Macam Cara Penulisan Komentar di Python

Komentar dalam pemrograman adalah bagian dari kode yang tidak akan dieksekusi oleh interpreter. Komentar biasanya digunakan untuk memberikan penjelasan tentang kode atau memberi petunjuk bagi programmer lain yang membaca kode tersebut. Dalam bahasa Python, komentar sangat penting karena dapat membuat kode lebih mudah dipahami dan dikelola. Ada beberapa jenis komentar yang dapat ditulis di Python, di antaranya adalah komentar tunggal (single-line) dan komentar multi-baris (multi-line).

Berikut ini adalah penjelasan mengenai cara-cara penulisan komentar di Python:

1. Komentar Satu Baris (Single-Line Comment)

Cara paling umum untuk menulis komentar dalam Python adalah dengan menggunakan simbol # di depan teks komentar. Semua teks setelah simbol # pada baris yang sama akan dianggap sebagai komentar dan tidak akan dieksekusi oleh interpreter Python.

# Ini adalah komentar satu baris
print("Hello, World!")  # Komentar ini ada di sebelah kode

Pada contoh di atas, kalimat # Ini adalah komentar satu baris dan # Komentar ini ada di sebelah kode tidak akan dijalankan oleh Python.

2. Komentar Multi-Baris (Multi-Line Comment)

Python sebenarnya tidak memiliki sintaks khusus untuk komentar multi-baris seperti beberapa bahasa pemrograman lain. Namun, ada beberapa cara yang dapat digunakan untuk membuat komentar yang terdiri dari lebih dari satu baris

a. Menggunakan Beberapa Simbol #

Salah satu cara untuk menulis komentar multi-baris adalah dengan menambahkan simbol # di setiap baris.

# Ini adalah komentar multi-baris
# Baris pertama
# Baris kedua
# Baris ketiga

Cara ini cukup sederhana, namun jika komentarnya panjang, Anda mungkin perlu menambahkan banyak simbol #.

b. Menggunakan String Literal (Triple Quotation Marks)

Cara lain untuk membuat komentar multi-baris adalah dengan menggunakan string literal yang diapit oleh tiga tanda kutip (”’ atau “””). String ini akan diabaikan oleh interpreter jika tidak di-assign ke variabel apapun, sehingga dapat berfungsi sebagai komentar.

'''
Ini adalah komentar multi-baris
dengan menggunakan string literal
yang diapit oleh tiga tanda kutip.
'''
print("Hello, World!")

Atau dengan menggunakan tanda kutip ganda:

"""
Ini juga merupakan contoh
komentar multi-baris
menggunakan tiga tanda kutip ganda.
"""
print("Hello, World!")

Penggunaan triple quotes ini sebenarnya bukan cara ideal untuk komentar karena pada dasarnya merupakan string literal. Namun, sering digunakan oleh programmer sebagai alternatif untuk membuat komentar panjang tanpa harus menulis banyak simbol #.

3. Komentar di Dalam Fungsi atau Kelas (Docstring)

Dalam Python, selain komentar biasa, ada juga yang disebut docstring (documentation string). Docstring adalah string literal yang ditempatkan pada awal fungsi, kelas, atau modul yang digunakan untuk memberikan deskripsi atau dokumentasi tentang blok kode tersebut.

Docstring biasanya menggunakan triple quotes (”’ atau “””) dan dapat diakses melalui atribut __doc__.

Contoh pada Fungsi:

def tambah(a, b):
    """
    Fungsi ini untuk menjumlahkan dua angka.
    a dan b adalah angka yang akan dijumlahkan.
    """
    return a + b

Contoh pada Kelas:

class Mahasiswa:
    """
    Kelas ini merepresentasikan seorang mahasiswa.
    """
    def __init__(self, nama, npm):
        """
        Inisialisasi atribut nama dan npm.
        """
        self.nama = nama
        self.npm = npm

Docstring ini memiliki fungsi penting dalam dokumentasi kode. Docstring juga dapat digunakan oleh berbagai alat bantu dokumentasi otomatis.

4. Komentar di Dalam Kode (Inline Comment)

Komentar yang ditulis pada baris yang sama dengan kode Python disebut inline comment. Biasanya, komentar ini ditulis setelah kode pada baris yang sama, dipisahkan dengan satu spasi dari kode tersebut.

x = 10  # Menginisialisasi variabel x dengan nilai 10
y = x + 5  # Menambahkan 5 ke dalam x

Inline comment sering digunakan untuk menjelaskan apa yang dilakukan oleh sebuah pernyataan tertentu di kode.

Penggunaan komentar yang tepat sangat penting untuk memastikan bahwa kode Anda mudah dipahami oleh orang lain (atau diri Anda sendiri di masa depan). Selalu gunakan komentar untuk menjelaskan bagian kode yang kompleks, mendokumentasikan fungsi, dan memberikan konteks pada logika yang tidak langsung terlihat dari kode itu sendiri.