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. Show
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 KomentarPada Python, ada 3 macam bentuk komentar, yaitu single line, inline, dan multiline.
DocstringDocstring 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.
Docstring dengan single line Bagaimana kalau membuat docstring menggunakan komentar singli line?
Ternyata menggunakan macam bentuk komentar lain, tidak bisa diterapkan pada docstring. Membuat DocumentationDocstring itu adalah komentar multiline, karena itu pada contoh di atas dengan single line menghasilkan output Umumnya syntax dasar membuat docstring ada 2 bentuk yang digunakan
Menggunakan Google Python Style Google telah merilis yang disebut dengan Google Python Style Guide termasuk didalamnya membuat komentar dokumentasi.
Akhir KataDocstring 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. Hai, kali ini kita akan belajar membuat komentar pada python sebelum masuk ke code adabaiknya kita paham dulu apa fungsi komentar Fungsi komentar
Membuat KomentarKomentar selalu diawali dengan #, dan saat di jalankan Python tidak akan membacanya: Contoh: Komentar dapat ditempatkan di akhir baris, dan Python akan mengabaikan sisa baris:Contoh:
Contoh:Komentar tidak harus berupa teks yang menjelaskan kode, komentar juga dapat digunakan untuk mencegah Python mengeksekusi kode:
Komentar Multi BarisPython punya dua cara untuk membuat komentar multi baris. Cara pertama menggunakan # untuk setiap baris komentar . Contoh: Jika cara diatas terlalu lama lama kalian bisa menggunakan tanda """ lalu memasukan kode didalamnya.Contoh: Selama string tidak ditetapkan ke komentar, Python akan membaca kode, tetapi jika dimasukan ke dalam variabel komentar maka Python akan mengabaikannya, sekian tutorial kali ini dan Anda telah membuat komentar multiline. Mari mencobaSudah mempelajari hal baru hari ini? ada baiknya jika di praktekan
Baca juga : Mau donasi lewat mana? Bank Transfer Paypal Trakteer BRI - Kevin Alfito (4152 0103 0882 532) Traktir creator minum kopi dengan cara memberi sedikit donasi. klik icon panah di atas Komentar dengan Python ditulis dengan karakter khusus yang mana *?Dengan adanya komentar, pengguna maupun pembaca program akan sangat terbantu dalam memahami script. Penulisan komentar pada python dapat ditulis menggunakan tanda pagar ( # ) saja.
Karakter apa yang perlu diletakkan di awal untuk memberikan komentar baris tunggal pada kode Python?#1 Dengan tanda pagar (#)
Tanda pagar (#) sangat umum digunakan dalam memberikan komentar pada kode.
Bagaimana cara membuat komentar kode program yang tidak dieksekusi Dibaikan di Python?Komentar juga dapat digunakan untuk mencegah kode dieksekusi oleh python. Untuk membuat komentar, cukup tambahkan # pada awal baris kode, dan python akan mengabaikan baris kode tersebut.
Bagaimana cara membuat komentar di dalam bahasa C?Komentar C++ ditulis dengan salah satu cara berikut:. Karakter /* (garis miring, tanda bintang), diikuti oleh urutan karakter apa pun (termasuk baris baru), diikuti oleh */ karakter. Sintaks ini sama dengan ANSI C.. Karakter // (dua garis miring), diikuti oleh urutan karakter apa pun.. |