Bagaimana Berkomentar di Ruby

Pada satu titik atau lainnya, setiap pengembang menemukan diri mereka dalam situasi di mana mereka perlu memodifikasi kode sumber skrip. Tanpa dokumentasi dan informasi yang tepat untuk memandu Anda, melakukan itu hampir tidak mungkin. Di situlah konsep mengomentari kode Anda berperan.

Komentar hanyalah informasi yang ditambahkan ke kode sumber program untuk tujuan dokumentasi. Penerjemah dan kompiler bahasa mengabaikan komentar. Meskipun useran utama dari komentar adalah untuk mendokumentasikan dan menjelaskan operasi dari sebuah blok kode, mereka dapat nyaman saat men-debug kode Anda.

Dalam tutorial ini, kita akan mempelajari berbagai cara mengomentari kode dalam skrip Ruby.

Penggunaan Dasar: Komentar Satu Baris

Ada berbagai jenis komentar di Ruby. Namun, yang paling mendasar adalah komentar satu baris.

Itu dimulai dengan simbol pound (#) dan berlanjut ke akhir baris.

# Ruby single line comment
print "Hello from Ruby!"

Seperti yang Anda lihat pada contoh di atas, komentar satu baris dimulai dengan simbol pound dan membentang ke akhir baris.

Interpreter Ruby mengabaikan teks di dalam komentar satu baris, meskipun ia membawa kode Ruby yang valid.

Komentar satu baris di Ruby dapat dimulai di awal atau akhir baris, seperti yang ditunjukkan di bawah ini:

print "Hello from Ruby!" # Ruby single line comment

Dalam hal ini, konten sebelum tanda pound (#) dihitung sebagai kode Ruby yang valid sedangkan konten setelahnya tidak.

Blokir/Komentar Multi-Baris

Dalam kasus lain, Anda perlu menjelaskan apa yang dilakukan kode secara lebih rinci. Untuk menyertakan komentar yang mencakup beberapa baris di Ruby, kami menerapkan komentar blok.

Ada dua cara untuk mengimplementasikan komentar blokir di Ruby:

1: =mulai/=akhir

Metode ini menggunakan format =begin dan =end untuk menyertakan baris di dalam blok sebagai komentar.

Berikut ini contohnya:

=begin
This is a comment
that spans multiple lines
and its very useful for detailed documentation
=end
print "Hi Block comments!"

Dalam jenis komentar ini, kita mulai dengan menggunakan kata kunci =begin diikuti oleh semua baris yang ingin kita komentari dan ditutup dengan =end.

Penggunaan format komentar ini jarang terjadi karena tidak menawarkan banyak fleksibilitas dalam format komentar, dan sangat tidak terbaca.

2: Beberapa Simbol Pound (#)

Cara paling umum untuk mengomentari beberapa baris di Ruby adalah dengan menambahkan setiap baris dengan tanda pound.

Berikut ini contohnya:

# This is another comment method
# that spans multiple lines
# and it's very useful for detailed documentation

Dalam hal ini, kami memiliki beberapa baris yang dikomentari. Menggunakan editor cararn, Anda dapat menyorot blok kode dan mengomentarinya sekaligus.

Komentar & Komentar Ajaib

Ruby adalah bahasa yang menarik karena menawarkan komentar ajaib. Komentar ajaib mengambil format yang mirip dengan komentar biasa, tetapi bukannya diabaikan oleh penerjemah, mereka mengubah perilaku penerjemah.

Komentar ajaib berisi arahan Ruby yang menentukan apa yang harus diubah tentang penerjemah.

Contoh di bawah ini menunjukkan komentar ajaib untuk memodifikasi pengkodean untuk literal string.

# encoding: utf-8

Meskipun di atas terlihat mirip dengan komentar biasa, ini berisi arahan yang dikenali Ruby.

Untuk mempelajari lebih lanjut tentang arahan komentar Magic, pertimbangkan Dokumentasi Komentar Ruby.

Ringkasan

Panduan singkat ini membahas berbagai jenis komentar Ruby, termasuk cara mengimplementasikannya dengan mudah.

Related Posts