Dokumentasi Function pada Pemrograman Python

Supaya source code mudah dimengerti dan diteruskan ke programmer lain maka  kita perlu memberikan penjelasan pada function Python yang kita buat.

Dokumentasi function pada pemrograman Python adalah seperti pada penjelasan berikut ini

1. Menambahkan sepasang tiga petik dua
   
   Dari aplikasi PyCharm pertama-tama kita menambahkan sepadang dari tiga buah petik dua seperti pada gambar di atas.
   
   
   Kita kemudian melakukan enter dan ada nilai default tertentu.
   
2. Diisi sesuai kebutuhan
   Contoh source code untuk dokumentasi adalah

   def tambah(a,b):
       """
       Inilah penjelasan-penjelasan
       :param a: bilangan pertama
       :param b: bilangan kedua
       :return: hasil berupa bilangan
       """
       return a+b
   
   def kurang(a,b):
       return a-b
   
   def kali(a,b):
       return a*b
   
   def bagi(a,b):
       return a/b
   

   Source code ini dapat kita lihat pada PyCharm dengan tampilan seperti pada gambar di bawah ini
   

   

3. Membaca dokumentasi dengan __doc__
   Kita dapat membaca dokumentasi dengan  __doc__ seperti source code berikut ini

   from pack01 import hitung
   
   print(hitung.tambah.__doc__)
   

   Tampilan pada PyCharm untuk dokumentasi dengan __ doc__ adalah seperti pada gambar di bawah ini
   

   

4. Membaca dokumentasi dengan help
   Kita dapat mengakses dokumentasi dengan help seperti pada source code berikut ini

   from pack01 import hitung
   
   print(help(hitung.tambah))
   

   Kita kemudian menjalankan source code pada PyCharm dengan hasil seperti pada gambar di bawah ini
   

Informasi lebih lanjut silahkan mengunjungi https://realpython.com/documenting-python-code/ .

Kunjungi www.proweb.co.id untuk menambah wawasan anda.