Komen Swift: Bagaimana menggunakannya dan Mengapa?

Dalam artikel ini, anda akan belajar mengenai komen Swift, mengapa dan bagaimana menggunakannya.

Komen adalah penjelasan atau anotasi yang dapat dibaca oleh pengaturcara dalam kod sumber program. Ia tidak diendahkan oleh penyusun semasa kod tersebut disusun.

Komen ditujukan untuk orang yang membaca kod untuk lebih memahami maksud dan fungsi program. Ia berguna ketika bekerja dalam satu pasukan untuk menjelaskan tujuan kod untuk ahli pasukan lain atau semasa bekerja semata-mata ia boleh bertindak sebagai peringatan untuk dimiliki.

Komen Pantas dan Jenisnya

Secara pantas terdapat dua jenis komen:

1. Komen Garis Tunggal

Di Swift, mana-mana baris yang bermula dengan dua garis miring //adalah komen satu baris. Segala-galanya bermula dengan dua garis miring //tidak dihiraukan oleh penyusun.

Anda boleh mendapatkan contoh mudah di bahagian atas taman permainan:

 //: Taman permainan - kata nama: tempat di mana orang boleh bermain

Ia bermula dengan dua garis miring //dan memberikan penjelasan yang bermakna mengenai fail sebagai ": Taman Permainan - kata nama: tempat di mana orang boleh bermain".

Contoh 1: Komen Garis Tunggal

 //Sample program //stores 3.14 in variable pi let pi = 3.14159 print(pi) 

Contoh di atas mengandungi dua komen baris tunggal:

 // Contoh program // menyimpan 3.14 dalam pi berubah

2. Komen Multiline

Sekiranya komen anda merangkumi berbilang baris, anda boleh memasukkannya ke dalam /*… */.

Komen multiline dimulakan dengan garis miring ke depan diikuti dengan tanda bintang ( /*) dan diakhiri dengan tanda bintang diikuti dengan garis miring ke depan ( */). Segala-galanya di antara /*dan */tidak diendahkan oleh penyusun pantas.

/ * Ini adalah komen berbilang baris. Selepas anda menulis komen berbilang baris, tambahkan * diikuti oleh / untuk mengakhirinya * /

Contoh 2: Komen berbilang baris

 /* 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 mengandungi komen berbilang baris.

/ * Nilai pi berkod mungkin kurang tepat. Oleh itu, anda boleh mengira penggunaan jenis data terbina untuk nilai yang lebih tepat * /

Perkara yang perlu diingat

Walaupun komen bermakna untuk lebih memahami maksud kod yang ditulis. Berikut adalah perkara yang perlu anda pertimbangkan semasa menulisnya:

  1. Jangan sertakan komen dengan // on multiline walaupun itu sah dan penyusun mengabaikan garis tersebut. Sebaliknya sertakannya di dalam komen multiline /*… */
    Contoh:
    // Ini adalah komen. // Gunakan bila perlu dan tepat
    Cara menulis komen di atas adalah betul tetapi tidak digalakkan kerana anda perlu menulis komen berbilang baris jika komennya lebih besar daripada satu baris. Cara yang lebih baik untuk menulis adalah menggunakan komen berbilang baris sebagai:
    / * Ini adalah komen. Gunakannya bila perlu dan tepat * /
  2. Komen baris tunggal boleh ditulis dalam baris yang berasingan atau bersama dengan kod dalam baris yang sama. Walau bagaimanapun, disarankan untuk menggunakan komen dalam baris yang berasingan.
    Contoh:
     let pi = 3.14159 // menyimpan 3.14 dalam pi berubah
    Cara ini untuk menulis komen adalah sah. Tetapi lebih baik menulis komen dalam baris yang terpisah seperti:
     // menyimpan 3.14 dalam variabel pi let pi = 3.14159 
  3. Walaupun anda seorang pembangun tunggal dalam satu pasukan, dan anda adalah satu-satunya yang menulis kodnya, jika tidak dikompromikan, anda akan mengalami kesukaran untuk mencuba tujuannya dalam program ini. Jadi, gunakannya dengan tepat dan berikan penerangan yang bermakna.
  4. Membuat komen sangat mudah dan bermakna.
  5. Jangan tulis komen yang tidak perlu pada kod anda.
  6. Dalam kebanyakan kes, gunakan komen untuk menerangkan 'mengapa' dan bukan 'bagaimana'.

Artikel menarik...