Tutorial Python 20 : Panduan Lengkap Cara Menulis Comment in Python

Last Updated on September 9, 2021 by

Comment in Python, adalah sebuah baris yang ada di dalam program komputer yang diabaikan oleh compiler dan interpreter. Apa maksudnya? Jadi, sama seperti pada bahasa program lainnya, Anda bisa menambahkan berbagai komentar pada program yang ada buat agar program Anda dapat dibaca oleh manusia.

Tujuan adanya komentar ini, agar kode-kode yang Anda buat dapat lebih mudah dipahami oleh orang lain, misalnya: kolega, tim, atau stakeholder dari popgram yang Anda buat. Komentar ini berisikan hal-hal yang menjelaskan dan menginformasikan masing-masing hal yang dilakukan oleh program.

Pada artikel kali ini, Codekey akan mengajak Anda untuk memahami comment in Python, cara membuat multiline comment in Python atau multiple line in Python. Jika Anda tertarik untuk tahu tentang komentar dalam Bahasa Python, simak terus artikel ini sampai akhir.

Comment in Python : Penjelasan Singkat

Dalam suatu pemrograman, penting untuk membuat program dengan kode-kode yang dapat dipahami oleh orang lain. Menambahkan nama yang pasti pada variable, mendefinisikan fungsi yang eksplisit, serta mengorganisasikan kode adalah cara terbaik untuk membuat kode-kode Anda lebih mudah untuk dipahami.

Namun, menambahkan komentar atau comments juga tak kalah penting untuk meningkatkan kode yang Anda buat agar lebih mudah lagi untuk dipahami.

Comment atau komentar adalah bagian yang tidak terpisahkan dari suatu program. Comment bisa muncul dalam bentuk docstrings tingkat modul, atau bahkan penjelasan sebaris yang membantu menjelaskan fungsi yang kompleks.

Komentar dapat berfungsi sebagai catatan untuk diri sendiri atau pengingat, atau dapat ditulis dengan maksud agar pemrogram lain dapat memahami apa yang dilakukan kode Anda. Hal ini tergantung pada tujuan program Anda dibuat.

Secara umum, merupakan ide yang baik untuk menulis komentar saat Anda sedang menulis atau memperbarui program agar Anda tidak lupa dengan apa saja yang sudah Anda buat sebelumnya.

Syntax Comment in Python

Comment pada Python dimulai dengan tanda tagar dan karakter spasi yang kemudian dilanjutkan dengan sebuah baris kalimat di belakangnya. Sebagai contoh:

# This is a comment

Karena komentar tidak akan dieksekusi oleh program, maka ketika Anda menjalankan program Anda akan melihat berbagai indikasi dari komentar tersebut. Komentar berada di dalam kode sumber ditujukan untuk dibaca oleh manusia, bukan dieksekusi oleh komputer atau mesin.

Komentar harus pendek dan to the point. Sementara PEP 8 menyarankan untuk menyimpan kode pada 79 karakter atau kurang per baris, ini menyarankan maksimal 72 karakter untuk komentar dan docstring sebaris. Jika komentar Anda mendekati atau melebihi panjang itu, maka Anda dapat menyebarkannya ke beberapa baris.

Bagaimana Cara Menulis Comment in Python

Setelah memahami syntax dasar dari komentar, kali ini Anda akan mempelajari dasar pembuatan komentar dalam bahasa Python.

Basic Comment in Python

Di bawah ini adalah bagaimana fungsi again() dari tutorial Cara Membuat Program Kalkulator Sederhana di Python 3 dikomentari, dengan komentar mengikuti setiap level indentasi kode:

# Fungsi utama akan mengurai argumen melalui variabel parser.

# Argumen ini akan ditentukan oleh pengguna di konsol. This will pass

# Ini akan meneruskan argumen kata yang ingin diuraikan pengguna

# bersama dengan nama file yang ingin digunakan pengguna, dan juga memberikan

# teks bantuan jika pengguna tidak meneruskan argumen dengan benar.

def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      "word",
      help=" kata yang akan dicari dalam file teks."
  )
  parser.add_argument(
      "filename",
      help=" mencari lokasi file teks yang akan dicari"
  )
...

Komentar dibuat untuk membantu developer memahami, apakah itu pemrogram asli atau orang lain yang menggunakan atau berkolaborasi dalam proyek. Jika komentar tidak dapat dipelihara dan diperbarui dengan baik bersama dengan basis kode, lebih baik tidak menyertakan komentar daripada menulis komentar yang bertentangan atau akan bertentangan dengan kode.

Saat mengomentari kode, Anda harus mencari jawaban mengapa kode tersebut harus ada di sana. Kecuali jika kodenya sangat rumit, melihat kode secara umum dapat mengetahui apa yang dilakukan kode tersebut atau bagaimana cara melakukannya.

Multiline Comment in Python

Multiline comment atau Multiple line comment in Python tidak didukung sebagaimana multiline comments dalam bahasa lainnya seperti C, Java, dan Go. Berikut ini adalah contohnya:

# Jadi anda tidak bisa
hanya dengan melakukan ini
di python

Pada contoh di atas, baris pertama tidak akan diindahkan oleh program. Namun, baris lainnya akan menghasilkan syntax eror. Sebaliknya, bahasa pemrograman seperti Java akan memungkinkan Anda untuk menyebarkan komentar melalui beberapa baris dengan cukup mudah.

Segala sesuatu antara /* dan */ diabaikan oleh program. Meskipun Python tidak memiliki fungsi native multiline comments, Anda dapat membuat komentar multibaris dengan Python. Ada dua cara sederhana untuk melakukannya.

Cara pertama cukup dengan menekan tombol ‘return’ setelah masing-masing baris, menambahkan tanda hash baru dan melanjutkan komentar Anda dari sana:

def multiline_contoh():
    # Ini adalah contoh yang cukup bagus
    # cara menyebarkan komentar
    # lebih dari beberapa baris dengan Python

Setiap baris akan dimulai dengan tanda has yang akan diabaikan oleh program. Beberapa hal lain yang bisa Anda lakukan adalah menggunakan string multiline dengan melakukan wrapping komentar Anda di dalam seperangkat triple quotes atau tanda petik tiga.

"""
Jika anda tidak ingin menekan `enter` dan
mengetik semua tanda hash itu, anda bisa
melakukan dengan cara ini saja sebagai gantinya

"""

Multiline comment in Python yang ada di atas seperti komentar multiline di Java, di mana semua yang diapit oleh tanda kutip tiga akan berfungsi sebagai komentar.

Meskipun ini memberi Anda fungsionalitas multiline, ini secara teknis ia bukanlah komentar. Baris di atas adalah string yang tidak ditetapkan ke variabel apa pun, jadi tidak dipanggil atau dirujuk oleh program Anda.

Namun, karena itu akan diabaikan saat runtime dan tidak akan muncul di bytecode.Hal itu bisa secara efektif bertindak sebagai komentar. Anda dapat melihat pada artikel ini untuk bukti bahwa string ini tidak akan muncul di bytecode.

Namun, berhati-hatilah di mana Anda menempatkan multiline comment in Python ini. Tergantung di mana mereka berada dalam komentar yang Anda buat, mereka bisa berubah menjadi docstrings, yang merupakan bagian dari dokumentasi yang terkait dengan fungsi atau metode.

Jika Anda menyelipkan suatu hal yang salah tepat setelah definisi fungsi, maka komentar yang Anda maksudkan akan dikaitkan dengan objek itu.

Anda harus berhati-hati jika ingin menggunakan cara ini. Jika Anda ragu, cukup beri tanda hash pada setiap baris berikutnya.

Komentar Blok

Komentar Blok bisa digunakan untuk menjelaskan kode yang lebih rumit atau kode yang mungkin tidak familiar oleh orang yang membaca kode Anda. Komentar dengan bentuk yang lebih panjang ini berlaku untuk beberapa atau semua kode yang mengikutinya, dan juga diindentasi pada tingkat yang sama dengan kode.

Dalam komentar blok, setiap baris dimulai dengan tanda pagar dan satu spasi. Jika Anda perlu menggunakan lebih dari satu paragraf, mereka harus dipisahkan oleh garis yang berisi satu tanda pagar.

Berikut adalah contoh komentar blok yang mendefinisikan apa yang terjadi di fungsi main() yang didefinisikan di bawah ini:

# Fungsi utama akan mengurai argumen melalui variabel parser.

# Argumen ini akan ditentukan oleh pengguna di konsol. This will pass

# Ini akan meneruskan argumen kata yang ingin diuraikan pengguna

# bersama dengan nama file yang ingin digunakan pengguna, dan juga memberikan

# teks bantuan jika pengguna tidak meneruskan argumen dengan benar.

def main():
  parser = argparse.ArgumentParser()
  parser.add_argument(
      "word",
      help=" kata yang akan dicari dalam file teks."
  )
  parser.add_argument(
      "filename",
      help=" mencari lokasi file teks yang akan dicari"
  )
...

Komentar blok biasanya digunakan ketika operasi kurang mudah dan karena itu menuntut penjelasan yang menyeluruh. Anda harus mencoba untuk tidak mengomentari kode secara berlebihan dan cenderung mempercayai pemrogram lain untuk memahami Python kecuali jika Anda menulis untuk audiens tertentu.

Inline Comment

Komentar sebaris atau inline comment terjadi pada baris pernyataan yang sama, mengikuti kode itu sendiri. Seperti komentar lainnya, mereka mulai dengan tanda pagar dan satu karakter spasi.

Umumnya, inline comment terlihat seperti ini:

[code]  # Inline comment about the code

Komentar sebaris harus digunakan dengan hemat, tetapi bisa efektif untuk menjelaskan bagian kode yang rumit atau tidak jelas. Mereka juga dapat berguna jika Anda berpikir Anda mungkin tidak ingat baris kode yang Anda tulis di masa mendatang, atau jika Anda berkolaborasi dengan seseorang yang Anda kenal mungkin tidak akrab dengan semua aspek kode.

Misalnya, jika Anda tidak menggunakan banyak matematika dalam program Python Anda, Anda atau kolaborator Anda mungkin tidak tahu bahwa berikut ini membuat bilangan kompleks, jadi Anda mungkin ingin menyertakan inline comment tentang itu:

c = 5 + 2b  # perhitungan matematika

Inline comment juga dapat digunakan untuk menjelaskan alasan di balik melakukan sesuatu, atau beberapa informasi tambahan, seperti pada:

num = 99  # mendefinisikan nilai num

Komentar yang dibuat sejalan harus digunakan hanya bila diperlukan dan bila dapat memberikan panduan yang bermanfaat bagi orang yang membaca program.

Demikianlah penjelasan tentang Comment in Python. Jika Anda tertarik untuk belajar Python, pastikan Anda mengunjungi semua seri artikel Python di Codekey.

Situs Codekey menyediakan berbagai tutorial, materi, pembahasan, tips, dan trik untuk Anda belajar berbagai bahasa pemrograman seperti Python, JavaScript, dan bahasa pemrograman lainnya. Jangan lupa untuk terus dapatkan update terbaru dari situs https://codekey.id/