Pemrograman

Bahasa

Framework

Peralatan

Info

3 Cara menulis komentar di bahasa pemrograman python

– 22 February 2015

Jangan biarkan kode python-mu dilihat oleh interpreter. Sembunyikanlah di balik pagar atau di dalam rumput. Kalau tidak, nanti program yang kamu buat bisa error.

logo python

Tulisan ini sebenarnya untuk menujukkan cara membuat komentar di python. Komentar adalah bagian dari kode yang tidak akan dibaca oleh iterpreter. Penulisan komentar di python dapat menggunakan tanda pagar (#) atau tanda petik tiga kali‒selanjutnya, akan saya sebut rumput, karena bentuknya memang mirip rumput‒(‘’’…’’’ atau “””…”””).

Sembunyikan di balik pagar

Tanda pagar (#) hanya membolehkan persembuyian untuk satu baris kode. Walaupun begitu, kita dapat menggunakan banyak pagar untuk menyembunyikan baris kode yang lebih dari satu baris. Contoh:

# kode ini telah aman dari ancaman intepreter
print("Hi interpreter! ini kode yang bisa anda baca")

# kode di bawah ini ilegal
# tidak boleh terlihat oleh interpreter
# writeln('hello.. saya kode dari pascal');

# hmm, ada juga kode nyasar yang nekat
# unjuk gigi di sini
puts "Bahasa pemrograman ruby memang keren!"

Di baris terakhir, terdapat kode yang nekat unjuk gigi. Akhirnya interpreter marah-marah:

$ python pagar.py
  File "pagar.py", line 10
    puts "Bahasa pemrograman ruby memang keren!"
                                               ^
SyntaxError: invalid syntax

Sembunyikan di dalam rumput

Ada dua jenis rumput yang dapat digunakan untuk bersembunyi: rumput daun tunggal () dan rumput daun ganda (). Rumput membolehkan persembunyian lebih dari satu baris kode. Contoh:

''' kode ini telah aman dari ancaman intepreter '''
print("Hi interpreter! ini kode yang bisa anda baca")

""" kode di bawah ini ilegal
 tidak boleh terlihat oleh interpreter
 writeln('hello.. saya kode dari pascal');
"""

''' hmm, ada juga kode nyasar yang nekat
 unjuk gigi di sini '''

puts "Bahasa pemrograman ruby memang keren!"

Di baris terakhir, terdapat kode yang tidak mau bersembunyi di dalam rumput. Akhirnya interpreter marah-marah:

$ python rumput.py
  File "rumput.py", line 12
    puts "Bahasa pemrograman ruby memang keren!"
                                               ^
SyntaxError: invalid syntax

Selain dapat menyembunyikan lebih dari satu baris kode, rumput juga dapat digunakan untuk menuliskan dokumentasi kelas. Inilah kelebihan lain dari rumput. Contoh:

class Pagar:
    """kelas pagar untuk membuat objek pagar. Dibuat oleh Ardianta Pargo sebagai contoh saja."""

    def __init__(self, warna, tinggi, bahan):
        self.warna = warna
        self.tinggi = tinggi
        self.bahan = bahan


# Mengakses dokumentasi kelas
print Pagar.__doc__

raw_input('\ntekan [enter] untuk melihat bantuan (dokumentasi) kelas: ')

help(Pagar) # untuk melihat dokumentasi kelas

Hasil:

$ python kelas_pagar.py
kelas pagar untuk membuat objek pagar.
dibuat oleh Ardianta Pargo
sebagai contoh saja.

tekan [enter] untuk melihat bantuan (dokumentasi) kelas:

Setelah menekan Enter:

Help on class Pagar in module __main__:

class Pagar
 |  kelas pagar untuk membuat objek pagar.
 |  dibuat oleh: Ardianta Pargo
 |  sebagai contoh saja.
 |  
 |  Methods defined here:
 |  
 |  __init__(self, warna, tinggi, bahan)
(END)

Daun juga dapat dipakai bersembunyi

Daun yang saya maksud adalah tanda petik tunggal () dan tanda petik ganda (). Tanda ini juga dapat dipakai untuk membuat komentar. Hampir sama seperti rumput, tapi daun hanya mampu menyembunyikan satu baris kode. Komentar dengan daun jarang digunakan, karena‒menurut saya‒bentuknya mirip seperti string dan membuat bingung saat membacanya. Saya lebih suka memakai pagar untuk sembunyikan satu baris kode. Contoh:

"ini komentar dengan daun ganda"
'ini juga komentar dengan dun tunggal'

print "Membuat komentar dengan daun"

Ketika dijalankan:

$ python komen_daun.py 
Membuat komentar dengan daun

No comments :

Post a Comment