Komentar digunakan untuk menambahkan informasi ke kode. Sebagian besar diabaikan oleh kompiler, tetapi spesialis manusia dapat membaca komentar tersebut ketika mereka melihat kode Anda. Komentar sangat penting bagi pengembang karena mereka memiliki waktu terbatas, dan berkomentar memungkinkan mereka mendapatkan informasi berharga sekaligus atau mencatat beberapa detail penting terkait kode. Mengakses data ini memungkinkan mereka membuat keputusan yang tepat dan bekerja lebih cepat.
Bagaimana Mengomentari Dapat Bermanfaat bagi Saya?
Komentar berguna bagi Anda secara pribadi dan bagi siapa saja yang mungkin perlu membaca atau mengedit kode ini nanti. Tapi bagaimana tepatnya?
- Komentar dapat menjadi penampung saat pengkodean. Pada saat itu Anda mungkin berasumsi sesuatu, dan Anda akan tahu apakah asumsi Anda benar di masa depan.
- Komentar dapat mendokumentasikan pemikiran Anda atau menjadi catatan untuk diri sendiri sehingga Anda tidak akan melupakan perbuatan Anda saat kembali lagi nanti.
- Anda dapat menyertakan komentar tentang apa yang telah Anda lakukan dalam kode Anda agar programmer lain dapat memahaminya dengan lebih baik dan lebih cepat (waktu pembuat kode sangat, sangat mahal).
- Anda dapat menggunakan komentar untuk menonaktifkan sementara atau mengaktifkan bagian yang bermasalah.
- Mengomentari setiap baris skrip mempermudah pelacakan di mana letak bug dalam program.
- Komentar dapat menjelaskan apa yang dilakukan baris kode tertentu, atau mengapa Anda memilih beberapa pendekatan tertentu untuk menghindari kesalahpahaman (misalnya, ketika beberapa bagian kode dimaksudkan untuk beberapa bagian atau tujuan tertentu yang harus Anda pahami dengan jelas) ,
- Anda dapat menulis seluruh paragraf yang menjelaskan semua detail tentang bagian kode jika diperlukan untuk pemula atau orang dari proyek lain. Mengomentari sering diperlukan saat menulis kueri SQL yang kompleks dengan banyak klausa seperti INNER JOIN, GROUP BY, dll.
- Berkomentar memungkinkan Anda membuat catatan tentang apa yang Anda lakukan. Ini membantu orang lain memahami bagaimana dan mengapa Anda melakukan sesuatu sehingga mereka dapat mempertahankan atau memodifikasinya sesuai kebutuhan.
Apakah SQL Bahasa yang Baik untuk Komentar?
Ya! Komentar paling sering digunakan bersama dengan bahasa seperti SQL dan PHP di mana kita dapat memasukkannya ke dalam file teks atau skrip menggunakan fungsi komentar * / (mis., /* Ini komentar saya */). Mereka biasanya juga mudah digunakan di tempat lain.
Bagaimana Berkomentar di SQL?
Fungsi komentar akan memungkinkan Anda menulis teks apa pun untuk menambahkan komentar dalam SQL. Itu tidak mempengaruhi hasil akhir selama itu muncul sebelum atau sesudah karakter tertentu yang telah diprogram sebelumnya.
Untuk menambahkan komentar dalam SQL, Anda dapat menggunakan simbol berikut:/* */ atau # atau — (tanda hubung ganda).
/* */ akan bekerja untuk situasi apa pun di mana Anda ingin memulai dan mengakhiri komentar Anda pada saat itu tanpa menggunakan apa pun (seperti tanda kutip tunggal).
# digunakan untuk satu baris kode pada satu waktu
— juga berlaku untuk satu baris kode dalam satu waktu. Jangan lupa beri spasi setelah tanda hubung ganda ini.
Dalam kode Anda akan terlihat sebagai berikut:
-- this is a comment# this is also a comment/*
multiline
comment
*/
Inilah perbedaan antara komentar satu baris dan multibaris:
mysql> SELECT 1+1; # This comment continues to the end of line
mysql> SELECT 1+1; -- This comment continues to the end of line
mysql> SELECT 1 /* this is an in-line comment */ + 1;
mysql> SELECT 1+
/*
this is a
multiple-line comment
*/
1;
Berikut ini contoh lain dari komentar multi-baris:
SELECT contact_id, last_name, first_name
/*
* Author: TechOnTheNet.com
* Purpose: To show a comment that spans multiple lines in your SQL
* statement in MySQL.
*/
FROM contacts;
Berkomentar Menggunakan Simbol #
komentar hash dasar style dapat disisipkan ke dalam teks seperti ini:
Select * from users ; # this will list usersBerkomentar Menggunakan Tanda hubung Ganda (–)
Ini kurang lebih sama (jangan lupa spasi). SQL standar sebenarnya tidak mengharuskan Anda menggunakan ruang di sana, tetapi MySQL menggunakannya untuk menghindari masalah dengan perintah seperti SELECT 10–1.
Select * from users ; -- this will list usersBerkomentar Menggunakan / * dan * / Simbol
Komentar multibaris ini, tidak seperti dua contoh sebelumnya, tidak harus berhenti di akhir baris.
Select * from users ; /* this will list users */Komentar yang Dapat Dieksekusi
Sebagai aturan, komentar diabaikan oleh siapa pun di ujung sana (karena hanya untuk programmer), tetapi beberapa jenis komentar – komentar yang dapat dieksekusi – mengaktifkan kode yang berjalan di beberapa sistem.
Dalam kasus kami, komentar yang dapat dieksekusi memungkinkan Anda untuk menggunakan kode SQL yang hanya akan dieksekusi di MYSQL, bukan di database lain.
Komentar yang dapat dieksekusi harus dimasukkan dalam garis miring bertanda bintang , seperti kode biasa:
/*! Kode khusus MySQL */
Namun, komentar yang dapat dieksekusi ini memerlukan sintaks khusus seperti di bawah ini:
/*!##### kode khusus MySQL */
Anda membutuhkan !##### bagian untuk memberi sinyal komentar yang dapat dieksekusi. Ini mewakili versi minimum MYSQL yang dapat mengeksekusi komentar.
Alih-alih hash pertama, gantikan versi utama MYSQL. Alih-alih yang kedua, versi yang lebih muda dan versi tambalan diganti dengan 2. versi terakhir.
Hanya MySQL 5.1.10 atau versi yang lebih baru yang dapat menjalankan komentar berikut:
CREATE TABLE t1 (
k INT AUTO_INCREMENT,
KEY (k)
) /*!50110 KEY_BLOCK_SIZE=1024; */
Kesimpulan
Komentar membuat program lebih mudah dibaca dengan menambahkan lebih banyak detail. Anda dapat menganggapnya agak mirip dengan hash – mereka mengurangi waktu yang diperlukan untuk memahami kode atau mengidentifikasi beberapa bagiannya secara drastis dengan memberikan cuplikan yang menangkap esensi teks. Jika Anda pernah bekerja dengan bukti tanpa pengetahuan atau mencoba masuk ke Facebook melalui Google, Anda akan tahu apa yang kami maksud.
Itulah mengapa penting untuk mengomentari kode Anda dan mengetahui cara melakukannya dengan benar. Menjaga kode Anda tetap akurat dengan catatan informatif membuat hidup semua spesialis yang terlibat menjadi lebih mudah.
