Belajar Python Bagian 4: Komentar dan Dokumentasi
Belajar Python Bagian 4: Komentar dan Dokumentasi

Setelah kita belajar Python tentang Indentasi, maka kita akan melanjutkan kembali pada bagian ke 4 ini tentang komentar dan dokumentasi. Secara umum komentar pada program bertujuan untuk menjelaskan algoritma dan keterangan yang diperlukan. Dengan memberikan komentar, untuk orang lain yang ikut mengerjakan proyek tersebut dapat memahami kode yang kita buat. Dan keuntungan bagi pembuat program juga memudahkan kedepannya apabila, melakukan perubahan-perubahan.

Komentar pada bahasa pemrograman Python dan yang lainnya, merupakan baris kode yang tidak ikut dieksekusi. Apapun kode yang berada dalam block komentar, tidak mempengaruhi output dari program tersebut.

Bentuk Komentar

Pada Python, ada 3 macam bentuk komentar, yaitu single line, inline, dan multiline.

  1. Single line
    # Single line dimulai dengan tanda pagar
    
  2. Inline
    print("Hello world") # inline dimulai dengan tanda pagar juga
    
  3. Multiline
    """
    Komentar multiline berada dalam kutip ganda 3 kali
    dan semua yang didalamnya tidak akan dieksekusi
    """
    

Docstring

Docstring adalah singkatan dari Documentation String. Digunakan untuk memberikan keterangan singkat atau sebagai dokumentasi pada class, function, atau modul yang dibuat.

Tidak seperti komentar yang biasa, dia berada didalam suatu fungsi dan kita bisa mengaksesnya. Seperti berikut.

# Membuat fungsi
def my_func():
     """Ini adalah tidak ada apa-apa"""
     return

# mengakses docstring dengan __doc__
print(my_func.__doc__)

Ini adalah tidak ada apa-apa

# bisa juga dengan seperti ini
help(my_func)

# yang ditampilkan seperti ini
Help on function my_func in module __main__:

my_func()
    Ini adalah tidak ada apa-apa

Docstring dengan single line

Bagaimana kalau membuat docstring menggunakan komentar singli line?

def greet(name, greeting="Hello"):
     # print a greeting
     # Optional parameter
     print("{} {}".format(greeting, name))

print(greet.__doc__)
None

help(greet)

Help on function greet in module __main__:

greet(name, greeting='Hello')
(END)

Ternyata menggunakan macam bentuk komentar lain, tidak bisa diterapkan pada docstring.

Membuat Documentation

Docstring itu adalah komentar multiline, karena itu pada contoh di atas dengan single line menghasilkan output None. Baik, sekarang kita akan coba membuat dokumentasi sederhana.

Umumnya syntax dasar membuat docstring ada 2 bentuk yang digunakan

  1. One line
    def hai():
        """Katakan hai pada teman Anda."""
        print("Hai temanku")
    
  2. Multi line
    def sapa(nama, bahasa="id"):
        """Ucapkan Hai untuk dia.
    
        Arguments:
        nama: untuk menyimpan namanya.
        bahasa: bahasa yang digunakannya.
        """
        print(bahasa+ " "+nama)
    

Menggunakan Google Python Style

Google telah merilis yang disebut dengan Google Python Style Guide termasuk didalamnya membuat komentar dokumentasi.

def hello(name, language="en"):
    """Say hello to a person.

    Args:
            name: the name of person as string
            language: the language code string

    Returns:
            A number.
    """

    print(greeting[language]+" "+name)
    return 4

Akhir Kata

Docstring adalah multiline comment yang bisa digunakan untuk mendokumentasikan modul, class, maupun fungsi dan method. Secara umum ada dua bentuk membuat dokumentasi yaitu one line atau hanya satu baris saja dan multiline atau banyak baris.

Demikian pada penggunaan komentar reguler yang terdiri dari 3 bentuk, ada single line, inline, dan juga multiline. Pada single line dan inline, diawali dengan tanda pagar (#) yang setiap karakter setelah tanda pagar ini tidak akan dijalankan oleh program. Perbedaan dari single line dan inline terletak pada penempatannya saja.

Selanjutnya belajar tentang date time di python

Formulir Anda tidak dapat disimpan. Silakan coba lagi.
Anda berhasil berlangganan

Newsletter

Jadi yang pertama mendapatkan pembaruan artikel Python dan Django