Di artikel ini, Anda akan mempelajari tentang komentar Swift, mengapa dan bagaimana menggunakannya.
Komentar adalah penjelasan atau penjelasan yang dapat dibaca programmer dalam kode sumber suatu program. Ini diabaikan oleh kompilator saat kode dikompilasi.
Komentar ditujukan bagi orang yang membaca kode untuk lebih memahami maksud dan fungsionalitas program. Ini dapat membantu saat bekerja dalam tim untuk mengklarifikasi tujuan kode untuk anggota tim lain atau saat bekerja, kode itu dapat bertindak sebagai pengingat untuk dimiliki.
Komentar Cepat dan Jenisnya
Secara cepat, ada dua jenis komentar:
1. Komentar Baris Tunggal
Di Swift, setiap baris yang dimulai dengan dua garis miring //adalah satu baris komentar. Segala sesuatu yang dimulai dengan dua garis miring //akan diabaikan oleh kompiler.
Anda dapat menemukan contoh sederhana di bagian atas taman bermain:
//: Playground - kata benda: tempat di mana orang bisa bermain
Dimulai dengan dua garis miring //dan memberikan penjelasan yang berarti tentang file tersebut sebagai ": Playground - kata benda: tempat di mana orang dapat bermain".
Contoh 1: Komentar Baris Tunggal
//Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi)
Contoh di atas berisi dua baris komentar:
// Program sampel // menyimpan 3,14 dalam variabel pi
2. Komentar Multiline
Jika komentar Anda mencakup banyak baris, Anda dapat memasukkannya ke dalam /*… */.
Komentar multiline dimulai dengan garis miring diikuti dengan tanda bintang ( /*) dan diakhiri dengan tanda bintang diikuti dengan garis miring ( */). Segala sesuatu di antaranya /*dan */diabaikan oleh kompilator swift.
/ * Ini adalah komentar multiline. Setelah Anda menulis komentar multiline, tambahkan * diikuti oleh / untuk mengakhirinya * /
Contoh 2: Komentar multiline
/* Hardcoded pi value may be less accurate. So you can calculate using in built data types for more accurate value */ let pi = Double.pi print(pi)
Contoh di atas berisi komentar multiline.
/ * Nilai pi yang di-hardcode mungkin kurang akurat. Jadi Anda dapat menghitung menggunakan tipe data bawaan untuk nilai yang lebih akurat * /
Hal-hal untuk diingat
Meskipun komentar bermakna untuk lebih memahami maksud dari kode yang ditulis. Berikut hal-hal yang perlu Anda pertimbangkan saat menulisnya:
- Jangan mengapit komentar dengan // pada multiline meskipun itu valid dan compiler mengabaikan baris tersebut. Alih-alih menyertakannya di dalam komentar multiline.
/*… */
Contoh:// Ini adalah komentar. // Gunakan jika perlu dan tepat
Cara menulis komentar di atas sudah benar tetapi tidak disarankan karena Anda perlu menulis komentar multiline jika komentar lebih dari satu baris. Cara yang lebih baik untuk menulis adalah menggunakan komentar multiline sebagai:/ * Ini adalah komentar. Gunakan jika perlu dan tepat * /
- Komentar baris tunggal dapat ditulis di baris terpisah atau bersama kode di baris yang sama. Namun, disarankan untuk menggunakan komentar di baris terpisah.
Contoh:misalkan pi = 3,14159 // menyimpan 3,14 dalam variabel pi
Cara menulis komentar ini valid. Tetapi lebih baik menulis komentar di baris terpisah seperti:// menyimpan 3,14 dalam variabel pi, misalkan pi = 3,14159
- Sekalipun Anda adalah pengembang tunggal dalam sebuah tim, dan Anda adalah satu-satunya yang menulis kode, jika tidak diberi komentar, Anda akan kesulitan untuk mengetahui tujuannya dalam program. Jadi, gunakan dengan tepat dan berikan deskripsi yang bermakna.
- Buatlah komentar menjadi sangat sederhana dan bermakna.
- Jangan menulis komentar yang tidak perlu pada kode Anda.
- Dalam kebanyakan kasus, gunakan komentar untuk menjelaskan 'mengapa' daripada 'bagaimana'.
