Cara Berkomentar dengan Python

Diperbarui pada Juli 2021

Pendahuluan

Keterampilan kunci dalam menulis kode adalah kemampuan untuk menggunakan komentar. Komentar adalah baris yang diabaikan oleh kompiler dan juru bahasa yang digunakan pengembang untuk meninggalkan catatan tentang fungsi kode. Selain itu, mereka juga dapat digunakan untuk menonaktifkan bagian dari kode.

Panduan ini akan menunjukkan cara menggunakan komentar dengan Python secara efektif.

Prasyarat

• Lingkungan pemrograman Python yang berfungsi
• Kemampuan untuk membuat dan mengedit file Python

Sintaks Komentar Python

Untuk menambahkan atau menandai baris sebagai komentar, mulailah dengan tanda hash (# ) dan spasi :

# This is a sample comment.

Menggunakan tanda hash untuk memulai baris memberi tahu sistem untuk mengabaikan semua yang ada di baris itu. Saat aplikasi berjalan, program berpura-pura seperti garis-garis itu tidak ada. Namun, Anda masih dapat melihatnya saat mengedit file.

Misalnya, di Halo Dunia program di bawah ini:

# Display the text "Hello, World!" on the screen.
print("Hello, World!")

Sistem menjalankan kode print("Hello, World") di baris empat, sedangkan baris di atasnya menjelaskan apa yang seharusnya dilakukan kode.

Anda dapat mengatur baris apa pun sebagai komentar, dan menggunakan sebanyak yang Anda suka. Jika kode Anda memiliki blok yang berbeda, Anda dapat menggunakan komentar untuk menjelaskan masing-masing blok. Misalnya:

# Define a variable flowers as a list of strings.
flowers = [‘rose’, ‘carnation’, ‘daisy’, ‘marigold’, ‘tulip’, ‘sunflower’]

# Create a for loop to iterate through flowers list, and displays each string item.
for flower in flowers:
            print(flower)

Blok Komentar Python

Blokir komentar adalah komentar yang lebih panjang yang terdiri dari beberapa baris dalam satu baris. Pengembang menggunakannya untuk menjelaskan kode yang lebih kompleks, terutama saat bekerja dalam tim.

Untuk menandai serangkaian baris sebagai komentar, tambahkan tanda hash + spasi di awal setiap baris:

# This is a comment
# that runs on to
# multiple lines.

Beberapa editor teks atau kode untuk pemrograman (seperti Notepad++ atau Atom) memungkinkan Anda untuk menyorot teks, lalu klik mouse untuk menandai blok sebagai komentar. Alat ini dapat menghemat waktu Anda untuk mengomentari setiap baris.

Komentar Multiline Python

Secara umum, disarankan untuk menggunakan # di awal setiap baris untuk menandainya sebagai komentar. Namun, mengomentari bagian besar membutuhkan banyak waktu dan Anda mungkin memerlukan cara cepat untuk mengomentari seluruh bagian. Dalam kasus seperti itu, Anda dapat menggunakan komentar multi-baris .

String multi-baris tidak berfungsi sebagai komentar Python tradisional, karena tidak ada fungsionalitas multi-baris resmi. Sebagai gantinya, gunakan string multi-baris yang dibungkus di dalam tanda kutip tiga (""" ) untuk mencapai fungsi serupa.

Misalnya:

def addition_test(a, b):
    result = a + b
    """
    This is a block
    of commented lines.
    They aren’t parsed and interpreted by the compiler.
    """
return result

Metode ini membuat konstanta teks tanpa fungsi, bukan komentar yang benar. Selama Anda tidak menambahkan apa pun yang mengakses string teks itu, ia berfungsi sama seperti komentar biasa.

Tanda kutip tiga bisa jadi rumit karena dalam beberapa keadaan itu menciptakan docstring jika kutipan tiga:

• mengikuti tanda tangan fungsi,
• mengikuti definisi kelas,
• ada di awal modul.

Jika Anda menempatkan """ di salah satu tempat yang tercantum di atas, Python membacanya sebagai dosctring . Docstrings memungkinkan Anda memasukkan teks yang dapat dibaca manusia ke dalam proyek. Ini biasanya digunakan untuk membuat dokumentasi yang merupakan bagian dari aplikasi dan dapat diakses saat runtime.

Komentar Sebaris Python

Anda dapat berkomentar di baris yang sama sebagai potongan kode menggunakan komentar sebaris . Waktu terbaik untuk menggunakan opsi ini adalah saat menjelaskan operasi yang rumit.

Gunakan komentar sebaris untuk menunjukkan tempat yang tepat yang ingin Anda klarifikasi. Tambahkan tanda hash standar + spasi untuk menandakan komentar sebaris:

function
    set variable
    run command
    run additional command        # Tricky part:  The program breaks if this line is removed.

Komentar sebaris digunakan untuk menambahkan konteks bagi orang yang membaca kode. Misalnya, Anda dapat menjelaskan tujuan suatu variabel, atau meninggalkan catatan tentang jenis variabel yang dibuat. Ini juga dapat membantu untuk menjelaskan mengapa perintah tertentu digunakan, seperti pada contoh di atas.

Komentar Python Keluar

Karena komentar membuat teks tidak terlihat oleh pengurai, Anda dapat menggunakannya untuk menonaktifkan perintah. Melakukannya memungkinkan Anda menguji segmen kode dengan dan tanpa tambahan baru.

Misalnya, dalam program pelemparan dadu sederhana ini, ada bagian yang dikomentari. Jika Anda menghapus tanda hash, Anda mengaktifkan kode untuk mengujinya.

import random
min = 1
max = 6

roll_again = "yes"

while roll_again == "yes" or roll_again == "y":
     print "Rolling the dice..."
     print "The values are...."
     print random.randint(min, max)
     print random.randint(min, max)

# Add two random numbers together for a sum
# while roll_again == “yes” or roll_again == “y”:
    # print ”Rolling the dice…”
    # print “You rolled a “
    # print random.randint(min,max) + random.randint(min, max)

    roll_again = raw_input("Roll the dice again?")

Mengapa Komentar Penting Dalam Python

Mengomentari dapat membantu Anda:

• Pahami kode Anda sendiri saat Anda kembali setelah jangka waktu yang lebih lama.
• Membuat Anda kembali lebih cepat.
• Masalah debug.
• Pahami pilihan kode tertentu saat bekerja dalam tim.
• Mencegah potensi masalah dengan menekankan pentingnya bagian kode tertentu.

Praktik Terbaik Komentar Kode Python

• Berkomentarlah dengan lekukan yang sama dengan kode yang Anda maksud. Ini memudahkan untuk melihat apa yang Anda maksud.
• Perbarui komentar Anda saat memperbarui kode. Komentar yang salah lebih buruk daripada tidak ada komentar.
• Gunakan kalimat lengkap. Gunakan huruf kapital untuk kata-kata yang sesuai, kecuali jika Anda merujuk ke pengenal (seperti variabel). Jangan pernah mengubah huruf besar kecil pengenal.
• Komentar blokir harus ditulis dalam kalimat lengkap, dengan titik. Bertujuan untuk 80 kata per baris atau kurang.
• Jika Anda memiliki beberapa kalimat dalam komentar, gunakan spasi ganda di antara kalimat.
• Tulis komentar dalam bahasa Inggris.
• Untuk memblokir komentar dengan beberapa paragraf, tambahkan baris kosong di antara paragraf dengan satu tag komentar sebelum baris kosong.
• Untuk komentar sebaris, beri setidaknya dua spasi di antara kode dan komentar. Gunakan komentar sebaris dengan hemat, dan hindari menggunakannya untuk menyatakan yang sudah jelas.

HINDARI:

• Jangan mengomentari kode yang sudah cukup jelas. Tetap berpegang pada prinsip menulis KERING (P tidak R ulangi Y diri kita sendiri) dan hindari BASAH (A ritus E sangat T wice) kode dan komentar.
• Hindari penggunaan komentar untuk menjelaskan kode yang berantakan - komentar harus mendukung kode, bukan membenarkannya.