Komentar untuk Ruby Code (Usage, Single, dan Multi-Line)

Komentar di Rubi kode adalah catatan dan penjelasan yang dimaksudkan untuk dibaca oleh programmer lain. Komentar itu sendiri diabaikan oleh penerjemah Ruby, jadi teks di dalam komentar tidak tunduk pada batasan apa pun.

Ini biasanya bentuk yang baik untuk meletakkan komentar di depan kelas dan metode serta potongan kode yang mungkin rumit atau tidak jelas.

Menggunakan Komentar Secara Efektif

Komentar harus digunakan untuk memberikan informasi latar belakang atau membubuhi keterangan kode yang sulit. Catatan yang hanya mengatakan apa baris kode langsung berikutnya tidak hanya jelas tetapi juga menambahkan kekacauan pada file.

Sangat penting untuk berhati-hati agar tidak menggunakan terlalu banyak komentar dan untuk memastikan komentar yang dibuat dalam file bermakna dan bermanfaat bagi programmer lain.

Shebang

Anda akan melihat bahwa semua program Ruby dimulai dengan komentar yang dimulai dengan #!. Ini disebut a peristiwa dan digunakan pada sistem Linux, Unix dan OS X.

Saat Anda menjalankan skrip Ruby, shell (seperti bash di Linux atau OS X) akan mencari shebang di baris pertama file. Shell kemudian akan menggunakan shebang untuk menemukan interpreter Ruby dan menjalankan skrip.

instagram viewer

Ruby Shebang yang disukai adalah #! / usr / bin / env ruby, meskipun Anda mungkin juga melihat #! / usr / bin / ruby atau #! / usr / local / bin / ruby.

Komentar Satu Baris

Komentar single-line Ruby dimulai dengan # karakter dan berakhir di akhir baris. Setiap karakter dari # karakter sampai akhir baris benar-benar diabaikan oleh penerjemah Ruby.

Itu # karakter tidak harus muncul di awal baris; itu bisa terjadi di mana saja.

Contoh berikut menggambarkan beberapa penggunaan komentar.

 #! / usr / bin / env ruby


 # Baris ini diabaikan oleh interpreter Ruby


 # Metode ini mencetak jumlah argumennya

 jumlah def (a, b)

 menempatkan + b

 akhir


 jumlah (10,20) # Cetak jumlah 10 dan 20 

Komentar Multi-Baris

Meskipun sering dilupakan oleh banyak programmer Ruby, Ruby memang memiliki komentar multi-line. Komentar multi-baris dimulai dengan = mulai token dan diakhiri dengan = akhir token.

Token ini harus dimulai pada awal baris dan menjadi satu-satunya yang ada di baris tersebut. Apa pun di antara kedua token ini diabaikan oleh penerjemah Ruby.

 #! / usr / bin / env ruby


 = mulai

 Antara = mulai dan = akhir, angka berapa pun

 baris dapat ditulis. Semua ini

 baris diabaikan oleh penerjemah Ruby.

 = akhir


 menempatkan "Halo dunia!"

Dalam contoh ini, kode akan dieksekusi sebagai Halo Dunia!

instagram story viewer