Cara menggunakan docstring pada python

Pada tutorial sebelumnya kita telah mempelajari dasar-dasar Phyton. Python biasa digunakan dalam pengembangan web, ilmu data, membuat prototipe perangkat lunak, dan sebagainya. Untungnya bagi pemula, Python memiliki sintaks sederhana yang mudah digunakan.

Ini menjadikan Python bahasa yang sangat baik untuk dipelajari bagi pemula. Pada pembahasan kali ini, kita akan belajar fungsi pada python. Kami akan memandu Anda untuk belajar dalam Python selangkah demi selangkah.

Table of Contents

Apa itu Functions?

Cara menggunakan docstring pada python

Funtions atau fungsi adalah cara mudah untuk membagi kode Anda menjadi blok yang berguna, memungkinkan Anda untuk memesan kode, membuatnya lebih mudah dibaca, dapat digunakan Kembali sehingga menghemat waktu. Selain itu, fungsi adalah cara utama untuk menentukan antarmuka sehingga programer dapat membagikan kode mereka.

Contoh sintaks fungsi dalam Python

def  nama_fungsi (parameter):
    "" "docstring" ""
    Pernyataan

Berikut adalah maksud dari sintaks diatas yang terdiri dari komponen-komponen:

  • Kata kunci def menandai awal dari tajuk fungsi.
  • Function_name untuk mengidentifikasi fungsi secara unik. Penamaan fungsi mengikuti aturan yang sama dalam menulis pengenal dengan Python.
  • Parameter (argumen) yang digunakan untuk meneruskan nilai ke suatu fungsi. Mereka opsional.
  • Simbol titik dua (:) untuk menandai akhir dari header fungsi.
  • String dokumentasi opsional (docstring) untuk mendeskripsikan fungsi.
  • Satu atau lebih pernyataan python valid yang menyusun badan dari fungsi. Pernyataan atau sintaks harus memiliki tingkat indentasi yang sama (biasanya 4 spasi).
  • Return, merupakan Pernyataan opsional untuk mengembalikan nilai dari fungsi.

Selain itu, perlu diketahui bahwa Python menggunakan blok. Blok adalah area kode yang ditulis dengan format sebagai berikut:

block_head:
    block perintah pertama
    blok perintah kedua

Artikel Terkait  Tutorial Python 31 : Python Exception, Yuk Kenali dan Pelajari!

Bagaimana cara memanggil fungsi dengan Python?

Caranya mudah, cukup tulis nama fungsi diikuti dengan (), letakkan argumen yang diperlukan di dalam tanda kurung. Contohnya sebagai berikut:

def my_function():
    print("Halo, ini Function Pertama-mu! ")

def my_function_with_args(username, ucapan):
    print("Halo, %s, ini Function Pertama-mu!, %s"%(username, ucapan))

def sum_two_numbers(a, b):
    return a + b

# perintah untuk mencetak hasil function - "Halo, ini Function Pertama-mu!"
my_function()

#perintah untuk mencetak hasil function- "Halo, Eka, ini Function Pertama-mu!, Selamat Mencoba ya"
my_function_with_args("Eka", "Selamat Mencoba ya")

# x akan menyimpan nilai sebesar 3!
x = sum_two_numbers(1,2)

Maka apabila dijalankan, hasilnya akan seperti berikut:

Halo, ini Function Pertama-mu! 
Halo, Eka, ini Function Pertama-mu!, Selamat Mencoba ya

Latihan

Bagaimana, mudah bukan? Sekarang saya akan memberikan Anda Latihan kode fungsi. Dalam latihan ini Anda akan menggunakan fungsi yang sudah ada, dan sambil menambahkan fungsi Anda sendiri untuk membuat program yang berfungsi penuh.

  • Tambahkan fungsi bernama list_benefits() yang mengembalikan daftar string berikut: “Kode yang lebih teratur”, “Kode yang lebih mudah dibaca”, “Penggunaan ulang kode yang lebih mudah”, “Memungkinkan programmer untuk berbagi dan menghubungkan kode bersama-sama”
  • Tambahkan fungsi bernama build_sentence(info)yang menerima satu argumen yang berisi string dan mengembalikan kalimat yang dimulai dengan string yang diberikan dan diakhiri dengan string “adalah manfaat dari fungsi!”
  • Jalankan dan lihat semua fungsi bekerja bersama!

Kunjungi website Codekey di https://codekey.id/. Codekey adalah Media Belajar Bahasa Pemrograman yang akan membantu Anda memecahkan masalah pemrograman dengan tutorial, tips, dan trik yang mudah dipahami. Jangan lupa kunjungi selalu Codekey agar Anda tidak ketinggalan informasi terbaru.

Setelah mempersiapkan segala perlengkapan untuk coding python dan mengetahui cara membuat program python, selanjutnya mari kita pelajari tentang aturan-aturan penulisan sintaks Python yang harus dipatuhi.

“Bagaimana kalau tidak dipathui?”

Resikonya bisa terjadi error 😄.

Pada artikel ini, saya akan membahas beberapa aturan dasar penulisan sintaks Python yang harus diketahui.

Agar nanti mudah dalam menulis program.

Apa saja aturan-aturannya?

Silahkan di simak..

1. Penulisan Statement Python

Statement adalah sebuah intruksi atau kalimat perintah yang akan dieksekusi oleh komputer.

Contoh:

print("Hello World!")
print("Belajar Python dari Nol")
nama = "petani kode"

Penulisan satu statement tidak diakhiri dengan tanda titik-koma.

Sedangkan, bila kita ingin menulis lebih dari satu statement dalam satu baris, maka kita harus memisahnya dengan titik-koma.

Contoh:

print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"

Tapi…

Menurut beberapa style guide python, tidak dianjurkan menulis lebih dari satu statement dalam satu baris. Karena akan sulit dibaca.

2. Penulisan String pada Python

String adalah teks atau kumpulan dari karakter.

String dalam pemrograman biasanya ditulis dengan dibungkus menggunakan tanda petik.

Bisa menggunakan tanda petik tunggal maupun ganda.

Contoh:

judul = "Belajar Pemrograman Python sampai Bisa"
penulis = 'Petani Kode'

Atau kita juga bisa menggunakan triple tanda petik.

Contoh:

judul = """Belajar Python dengan Cepat"""
penulis = '''Petani Kode'''

3. Penuilsan Case pada Python

Sintak Python bersifat case sensitive, artinya

print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"
3 dengan
print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"
4 dibedakan.

Contoh:

judul = "Belajar Dasa-dasar Python"
Judul = "Belajar Membuat Program Python"

Antara variabel

print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"
5 dengan
print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"
6 itu dibedakan…

Case Style

Menurut rekomendasi style guide Google, berikut ini contoh penulisan case yang disarankan:

## Snake Case digunakan pada:
module_name, package_name, method_name, function_name, , global_var_name, instance_var_name, function_parameter_name, local_var_name.

## CamelCase digunakan Pada:
ClassName, ExceptionName

## ALL CAPS digunakan Pada:
GLOBAL_CONSTANT_NAME

Baca juga: 4 Macam Gaya Penulisan Case dalam Pemrograman

4. Penulisan Blok Program Python

Blok program adalah kumpulan dari beberpaa statement yang digabungkan dalam satu blok.

Penulisan blok program harus ditambahkan indentasi (tab atau spasi 2x/4x).

Cara menggunakan docstring pada python

✔️ Contoh yang benar:

# blok percabangan if
if username == 'petanikode':
    print("Selamat Datang Admin")
    print("Silahkan ambil tempat duduk")

# blok percabangan for
for i in range(10):
    print i

❌ Contoh yang salah:

# blok percabangan if
if username == 'petanikode':
print("Selamat Datang Admin")
print("Silahkan ambil tempat duduk")

# blok percabangan for
for i in range(10):
print i

Ada beberapa macam blok program:

  • Blok Percabangan
  • Blok Perulangan
  • Blok Fungsi
  • Blok Class
  • Blok Exception
  • Blok With

5. Cara Penulisan Komentar pada Python

Komentar merupakan baris kode yang tidak akan dieksekusi.

Komentar digunakan untuk memberikan informasi tambahan dan untuk menonaktifkan kode.

Ada beberapa cara menulis komentar pada pemrograman Python.

Menggunakan Tanda Pagar (print("Hello"); print("World"); print("Tutorial Python untuk Pemula") nama_depan = "petani"; nama_belakang = "kode"7)

Cara pertama menggunakan tanda pagar (

print("Hello"); print("World"); print("Tutorial Python untuk Pemula")
nama_depan = "petani"; nama_belakang = "kode"
7).

Cara ini paling sering digunakan.

Contohnya:

# ini adalah komentar
# Ini juga komentar

Menggunakan Tanda Petik

Selain untuk mengapit teks (string), tanda petik juga dapat digunakan untuk membuat komentar.

Contoh:

"Ini adalah komentar dengan tanda petik ganda"
'Ini juga komentar, tapi dengan tanda petik tunggal'

Penulisan komentar dengan tanda petik jarang digunakan, kebanyakan orang lebih memilih untuk menggunakan tanda pagar. Jadi…tidak direkomendasikan.

Apa itu Docstring pada Python?

Doc String Python memiliki fitur documentation string, seringnya disebut dengan nama docstring. Docstring berguna untuk mendokumentasikan program agar mudah untuk dipahami dan digunakan. Secara interaktif anda dapat mengakses docstring dengan fungsi help.

Apa yang dimaksud dengan fungsi pada Python?

Fungsi dalam python merupakan kumpulan perintah yang dikelompokkan menjadi satu. Fungsi yang telah dibuat ini nantinya akan bisa dipanggil serta digunakan berulang kali. Dengan menggunakan fungsi, programmer dapat mengefisienkan penulisan program, terutama program besar.

Apa tujuan penulisan function di dalam Python programming?

Fungsi dalam Python dapat digunakan untuk mengefisiensi program serta memudahkan programmer dalam menjalankan program besar.

Apa itu print di Python?

Apa Itu Fungsi Print? Fungsi print pada python adalah sebuah fungsi yang digunakan untuk memunculkan output yang ingin kita print pada console. Fungsi print terlihat sangat simple namun ternyata print merupakan fungsi yang paling banyak digunakan dalam sintaks python.