Apa itu Komentar HTML dan Bagaimana Mereka Digunakan
Ketika Anda melihat halaman web di browser, Anda melihat representasi visual dari perangkat lunak apa (browser web) yang ditampilkan berdasarkan kode halaman web tertentu. Jika Anda melihat kode sumber laman web tersebut, Anda akan melihat dokumen yang terdiri dari berbagai elemen HTML, termasuk paragraf, judul, daftar, tautan, gambar, dan banyak lagi. Semua elemen ini ditampilkan oleh browser pada layar pengunjung sebagai bagian dari tampilan situs web. Satu hal yang mungkin Anda temukan dalam kode HTML yang tidak ditampilkan di layar seseorang adalah apa yang dikenal sebagai "komentar HTML".
Apa itu Komentar?
Komentar adalah rangkaian kode dalam HTML, XML, atau CSS yang tidak dilihat atau ditindaklanjuti oleh browser atau parser. Ini hanya ditulis ke dalam kode untuk memberikan informasi tentang kode itu atau umpan balik lain dari pengembang kode.
Sebagian besar bahasa pemrograman memiliki komentar, umumnya digunakan oleh pengembang kode untuk satu atau bahkan lebih dari satu, dari alasan berikut:
- Jelaskan dan jelaskan kode rumit kepada seseorang yang mungkin harus mengerjakannya di masa depan - termasuk diri mereka sendiri! Mereka mungkin kembali ke kode 3 atau 6 dari 12 bulan atau lebih kemudian dan tidak ingat mengapa mereka melakukan sesuatu dengan cara tertentu. Komentar dapat membantu menjawab pertanyaan mereka dan mengingatkan mereka tentang di mana pikiran mereka ketika mereka pertama kali mengembangkan halaman itu.
- Berikan detail tentang kapan kode diedit atau ditinjau. Ini dapat membantu informasi dan bertindak seperti log pengembangan saat situs terakhir dikerjakan.
- Hapus bagian kode, tetapi biarkan tersedia untuk digunakan nanti. Ini sering dilakukan selama pengujian dan debugging situs. Jika Anda memiliki masalah di situs dan tidak yakin apa penyebabnya, Anda dapat mengomentari bagian satu per satu ke quarentine dan mengidentifikasi masalah, dan kemudian memperbaiki masalah apa pun yang Anda hadapi.
- Mengobrol dengan pengembang lain yang bekerja pada kode. Ini kemungkinan akan dilakukan selama pengembangan sebagai cara untuk berbagi detail dengan orang lain yang mengerjakan kode pada saat yang bersamaan. Jika komentar ini murni percakapan pengembangan, itu adalah praktik terbaik untuk menghapusnya dari kode sebelum situs diluncurkan.
Secara tradisional, komentar dalam HTML digunakan untuk hampir semua elemen, dari penjelasan struktur tabel kompleks hingga pernyataan informatif dari konten laman itu sendiri. Karena komentar tidak diberikan di browser, Anda dapat menambahkannya di mana saja dalam HTML dan tidak perlu khawatir tentang apa yang akan dilakukan saat situs dilihat oleh pelanggan.
Cara Menulis Komentar
Menulis komentar dalam HTML, XHTML, dan XML sangat mudah. Cukup kelilingi teks yang ingin Anda komentari dengan yang berikut:
dan ->Seperti yang Anda lihat, komentar ini dimulai dengan "kurang dari simbol", ditambah tanda seru dan dua tanda hubung. Komentar diakhiri dengan dua tanda garis dan "lebih besar dari: simbol. Di antara karakter-karakter itu Anda dapat menulis apa pun yang Anda inginkan untuk menyusun isi komentar.
Dalam CSS, itu sedikit berbeda, menggunakan komentar kode C daripada HTML Anda mulai dengan garis miring ke depan diikuti dengan tanda bintang. Anda mengakhiri komentar dengan kebalikannya, tanda bintang diikuti dengan garis miring ke depan.
/ * komentar teks * /Komentar adalah Seni Sekarat
Kebanyakan programmer tahu nilai komentar yang bermanfaat . Kode yang dikomentari membuatnya lebih mudah untuk kode yang akan ditransfer dari satu anggota tim ke yang lain. Komentar membantu Anda tim QA untuk menguji kode, karena mereka dapat memberi tahu apa yang dimaksudkan pengembang - bahkan jika itu tidak tercapai. Sayangnya, dengan popularitas platform pengarang situs web seperti Wordpress, yang memungkinkan Anda untuk bangun dan berjalan dengan tema terpilih yang menangani banyak, jika tidak semua, dari HTML untuk Anda, komentar tidak sering digunakan oleh tim web. Ini karena komentar sangat sulit untuk dilihat di sebagian besar alat authoring visual jika Anda tidak bekerja langsung dengan kode. Misalnya, daripada melihat, di bagian atas halaman web:
Alat visual menunjukkan ikon kecil untuk menunjukkan bahwa komentar ada di sana. Jika perancang tidak secara fisik membuka komentar, dia mungkin tidak akan pernah melihatnya. Dan dalam kasus halaman di atas, dapat menimbulkan masalah jika ia mengedit halaman dan pengeditan itu ditulis berlebihan oleh skrip yang disebutkan dalam komentar.
Apa yang bisa dilakukan?
- Tulis komentar yang bermanfaat dan bermanfaat. Jangan berharap orang lain membaca komentar Anda jika terlalu panjang atau tidak menyertakan informasi bermanfaat.
- Sebagai pengembang, Anda harus selalu meninjau komentar apa pun yang Anda lihat di halaman.
- Gunakan alat yang disediakan oleh program authoring yang memungkinkan Anda untuk menambahkan komentar.
- Gunakan manajemen konten untuk mengontrol cara halaman diedit.
Bahkan jika Anda adalah satu-satunya orang yang mengedit halaman web Anda, komentar dapat bermanfaat. Jika Anda hanya mengedit halaman yang rumit setahun sekali, mudah untuk melupakan bagaimana Anda membangun tabel atau menyusun CSS. Dengan komentar, Anda tidak perlu mengingat, seperti yang tertulis di sana untuk Anda.
Artikel asli oleh Jennifer Krynin. Diedit oleh Jeremy Girard pada 5/5/17